GET

/#Action=DescribeType

http://cloudformation.{region}.amazonaws.com/#Action=DescribeType

Returns detailed information about an extension that has been registered. If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Access Token Required: API Key

Query Params

Typestring

The kind of extension. Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.

Allowed:

TypeNamestring

The name of the extension. Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.

Arnstring

The Amazon Resource Name (ARN) of the extension. Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.

VersionIdstring

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered. If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific extension version. Otherwise, it returns information about the default extension version.

PublisherIdstring

The publisher ID of the extension publisher. Extensions provided by Amazon Web Services are not assigned a publisher ID.

PublicVersionNumberstring

The version number of a public third-party extension.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://cloudformation.{region}.amazonaws.com/#Action=DescribeType' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}