AWS API Changes

2020/05/15 - AWS CloudFormation - 2 updated api methods

Changes This release adds support for the following features: 1. DescribeType and ListTypeVersions APIs now output a field IsDefaultVersion, indicating if a version is the default version for its type; 2. Add StackRollbackComplete waiter feature to wait until stack status is UPDATE_ROLLBACK_COMPLETE; 3. Add paginators in DescribeAccountLimits, ListChangeSets, ListStackInstances, ListStackSetOperationResults, ListStackSetOperations, ListStackSets APIs.

DescribeType (updated)

Link ¶
Changes (response)

{'IsDefaultVersion': 'boolean'}

Returns detailed information about a type that has been registered.

If you specify a VersionId , DescribeType returns information about that specific type version. Otherwise, it returns information about the default type version.

See also: AWS API Documentation

Request Syntax

client.describe_type(
    Type='RESOURCE',
    TypeName='string',
    Arn='string',
    VersionId='string'
)

type Type

string

param Type

The kind of type.

Currently the only valid value is RESOURCE .

Conditional: You must specify either TypeName and Type , or Arn .

type TypeName

string

param TypeName

The name of the type.

Conditional: You must specify either TypeName and Type , or Arn .

type Arn

string

param Arn

The Amazon Resource Name (ARN) of the type.

Conditional: You must specify either TypeName and Type , or Arn .

type VersionId

string

param VersionId

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

If you specify a VersionId , DescribeType returns information about that specific type version. Otherwise, it returns information about the default type version.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Type': 'RESOURCE',
    'TypeName': 'string',
    'DefaultVersionId': 'string',
    'IsDefaultVersion': True|False,
    'Description': 'string',
    'Schema': 'string',
    'ProvisioningType': 'NON_PROVISIONABLE'|'IMMUTABLE'|'FULLY_MUTABLE',
    'DeprecatedStatus': 'LIVE'|'DEPRECATED',
    'LoggingConfig': {
        'LogRoleArn': 'string',
        'LogGroupName': 'string'
    },
    'ExecutionRoleArn': 'string',
    'Visibility': 'PUBLIC'|'PRIVATE',
    'SourceUrl': 'string',
    'DocumentationUrl': 'string',
    'LastUpdated': datetime(2015, 1, 1),
    'TimeCreated': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the type.
- Type (string) --
  
  The kind of type.
  
  Currently the only valid value is RESOURCE .
- TypeName (string) --
  
  The name of the registered type.
- DefaultVersionId (string) --
  
  The ID of the default version of the type. The default version is used when the type version is not specified.
  
  To set the default version of a type, use `` SetTypeDefaultVersion `` .
- IsDefaultVersion (boolean) --
  
  Whether the specified type version is set as the default version.
- Description (string) --
  
  The description of the registered type.
- Schema (string) --
  
  The schema that defines the type.
  
  For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide .
- ProvisioningType (string) --
  
  The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
  
  Valid values include:
  - FULLY_MUTABLE : The type includes an update handler to process updates to the type during stack update operations.
  - IMMUTABLE : The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.
  - NON_PROVISIONABLE : The type does not include all of the following handlers, and therefore cannot actually be provisioned.
    - create
    - read
    - delete
- DeprecatedStatus (string) --
  
  The deprecation status of the type.
  
  Valid values include:
  - LIVE : The type is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
  - DEPRECATED : The type has been deregistered and can no longer be used in CloudFormation operations.
- LoggingConfig (dict) --
  
  Contains logging configuration information for a type.
  - LogRoleArn (string) --
    
    The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
  - LogGroupName (string) --
    
    The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
- ExecutionRoleArn (string) --
  
  The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an * IAM execution role * that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
- Visibility (string) --
  
  The scope at which the type is visible and usable in CloudFormation operations.
  
  Valid values include:
  - PRIVATE : The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE .
  - PUBLIC : The type is publically visible and usable within any Amazon account.
- SourceUrl (string) --
  
  The URL of the source code for the type.
- DocumentationUrl (string) --
  
  The URL of a page providing detailed documentation for this type.
- LastUpdated (datetime) --
  
  When the specified type version was registered.
- TimeCreated (datetime) --
  
  When the specified type version was registered.

ListTypeVersions (updated)

Link ¶
Changes (response)

{'TypeVersionSummaries': {'IsDefaultVersion': 'boolean'}}

Returns summary information about the versions of a type.

See also: AWS API Documentation

Request Syntax

client.list_type_versions(
    Type='RESOURCE',
    TypeName='string',
    Arn='string',
    MaxResults=123,
    NextToken='string',
    DeprecatedStatus='LIVE'|'DEPRECATED'
)

type Type

string

param Type

The kind of the type.

Currently the only valid value is RESOURCE .

Conditional: You must specify either TypeName and Type , or Arn .

type TypeName

string

param TypeName

The name of the type for which you want version summary information.

Conditional: You must specify either TypeName and Type , or Arn .

type Arn

string

param Arn

The Amazon Resource Name (ARN) of the type for which you want version summary information.

Conditional: You must specify either TypeName and Type , or Arn .

type MaxResults

integer

param MaxResults

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

type NextToken

string

param NextToken

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null .

type DeprecatedStatus

string

param DeprecatedStatus

The deprecation status of the type versions that you want to get summary information about.

Valid values include:

LIVE : The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
DEPRECATED : The type version has been deregistered and can no longer be used in CloudFormation operations.

The default is LIVE .

rtype

dict

returns

Response Syntax

{
    'TypeVersionSummaries': [
        {
            'Type': 'RESOURCE',
            'TypeName': 'string',
            'VersionId': 'string',
            'IsDefaultVersion': True|False,
            'Arn': 'string',
            'TimeCreated': datetime(2015, 1, 1),
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TypeVersionSummaries (list) --
  
  A list of TypeVersionSummary structures that contain information about the specified type's versions.
  - (dict) --
    
    Contains summary information about a specific version of a CloudFormation type.
    - Type (string) --
      
      The kind of type.
    - TypeName (string) --
      
      The name of the type.
    - VersionId (string) --
      
      The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.
    - IsDefaultVersion (boolean) --
      
      Whether the specified type version is set as the default version.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the type version.
    - TimeCreated (datetime) --
      
      When the version was registered.
    - Description (string) --
      
      The description of the type version.
- NextToken (string) --
  
  If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null .