# DescribeTypeRegistration


Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using [RegisterType](API_RegisterType.md), you can then use [DescribeTypeRegistration](#API_DescribeTypeRegistration) to monitor the progress of that registration request.

Once the registration request has completed, use [DescribeType](API_DescribeType.md) to return detailed information about an extension.

## Request Parameters


 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** RegistrationToken **   
The identifier for this registration request.  
This registration token is generated by CloudFormation when you initiate a registration request using [RegisterType](API_RegisterType.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: Yes

## Response Elements


The following elements are returned by the service.

 ** Description **   
The description of the extension registration request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** ProgressStatus **   
The current status of the extension registration request.  
Type: String  
Valid Values: `COMPLETE | IN_PROGRESS | FAILED` 

 ** TypeArn **   
The Amazon Resource Name (ARN) of the extension being registered.  
For registration requests with a `ProgressStatus` of other than `COMPLETE`, this will be `null`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+` 

 ** TypeVersionArn **   
The Amazon Resource Name (ARN) of this specific version of the extension being registered.  
For registration requests with a `ProgressStatus` of other than `COMPLETE`, this will be `null`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

## Examples


### DescribeTypeRegistration while registration is in progress


The following example shows a typical response to `DescribeTypeRegistration` while CloudFormation is in the process of registering the extension.

#### Sample Request


```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeTypeRegistration
 &Version=2010-05-15
 &RegistrationToken=03458954-61b1-44e9-90d8-f1b81example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191203T232905Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response


```
<DescribeTypeRegistrationResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeTypeRegistrationResult>
    <Description>Deployment is currently in VALIDATION_STAGE of status IN_PROGRESS; Next is DEPLOY_STAGE with status PENDING</Description>
    <ProgressStatus>IN_PROGRESS</ProgressStatus>
  </DescribeTypeRegistrationResult>
  <ResponseMetadata>
    <RequestId>5feae575-40a4-474c-b81c-ca861example</RequestId>
  </ResponseMetadata>
</DescribeTypeRegistrationResponse>
```

### DescribeTypeRegistration once registration complete


The following example shows the response to `DescribeTypeRegistration` once CloudFormation has successfully completed registering the extension.

#### Sample Request


```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeTypeRegistration
 &Version=2010-05-15
 &RegistrationToken=03458954-61b1-44e9-90d8-f1b81example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191203T233327Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response


```
<DescribeTypeRegistrationResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeTypeRegistrationResult>
    <Description>Deployment is currently in DEPLOY_STAGE of status COMPLETED; </Description>
    <ProgressStatus>COMPLETE</ProgressStatus>
    <TypeArn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example</TypeArn>
    <TypeVersionArn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example/00000001</TypeVersionArn>
  </DescribeTypeRegistrationResult>
  <ResponseMetadata>
    <RequestId>2d187120-6f6e-4d43-80f5-99b588example</RequestId>
  </ResponseMetadata>
</DescribeTypeRegistrationResponse>
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeTypeRegistration)