CloudFormation / Client / batch_describe_type_configurations

batch_describe_type_configurations#

CloudFormation.Client.batch_describe_type_configurations(**kwargs)#

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.

For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Request Syntax

response = client.batch_describe_type_configurations(
    TypeConfigurationIdentifiers=[
        {
            'TypeArn': 'string',
            'TypeConfigurationAlias': 'string',
            'TypeConfigurationArn': 'string',
            'Type': 'RESOURCE'|'MODULE'|'HOOK',
            'TypeName': 'string'
        },
    ]
)

Parameters:

TypeConfigurationIdentifiers (list) –

[REQUIRED]

The list of identifiers for the desired extension configurations.

(dict) –

Identifying information for the configuration of a CloudFormation extension.
- TypeArn (string) –
  
  The Amazon Resource Name (ARN) for the extension, in this account and Region.
  
  For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
- TypeConfigurationAlias (string) –
  
  The alias specified for this configuration, if one was specified when the configuration was set.
- TypeConfigurationArn (string) –
  
  The Amazon Resource Name (ARN) for the configuration, in this account and Region.
- Type (string) –
  
  The type of extension.
- TypeName (string) –
  
  The name of the extension type to which this configuration applies.

Return type:

dict

Returns:

Response Syntax

{
    'Errors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'TypeConfigurationIdentifier': {
                'TypeArn': 'string',
                'TypeConfigurationAlias': 'string',
                'TypeConfigurationArn': 'string',
                'Type': 'RESOURCE'|'MODULE'|'HOOK',
                'TypeName': 'string'
            }
        },
    ],
    'UnprocessedTypeConfigurations': [
        {
            'TypeArn': 'string',
            'TypeConfigurationAlias': 'string',
            'TypeConfigurationArn': 'string',
            'Type': 'RESOURCE'|'MODULE'|'HOOK',
            'TypeName': 'string'
        },
    ],
    'TypeConfigurations': [
        {
            'Arn': 'string',
            'Alias': 'string',
            'Configuration': 'string',
            'LastUpdated': datetime(2015, 1, 1),
            'TypeArn': 'string',
            'TypeName': 'string',
            'IsDefaultConfiguration': True|False
        },
    ]
}

Response Structure

(dict) –
- Errors (list) –
  
  A list of information concerning any errors generated during the setting of the specified configurations.
  - (dict) –
    
    Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
    - ErrorCode (string) –
      
      The error code.
    - ErrorMessage (string) –
      
      The error message.
    - TypeConfigurationIdentifier (dict) –
      
      Identifying information for the configuration of a CloudFormation extension.
      - TypeArn (string) –
        
        The Amazon Resource Name (ARN) for the extension, in this account and Region.
        
        For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
      - TypeConfigurationAlias (string) –
        
        The alias specified for this configuration, if one was specified when the configuration was set.
      - TypeConfigurationArn (string) –
        
        The Amazon Resource Name (ARN) for the configuration, in this account and Region.
      - Type (string) –
        
        The type of extension.
      - TypeName (string) –
        
        The name of the extension type to which this configuration applies.
- UnprocessedTypeConfigurations (list) –
  
  A list of any of the specified extension configurations that CloudFormation could not process for any reason.
  - (dict) –
    
    Identifying information for the configuration of a CloudFormation extension.
    - TypeArn (string) –
      
      The Amazon Resource Name (ARN) for the extension, in this account and Region.
      
      For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
    - TypeConfigurationAlias (string) –
      
      The alias specified for this configuration, if one was specified when the configuration was set.
    - TypeConfigurationArn (string) –
      
      The Amazon Resource Name (ARN) for the configuration, in this account and Region.
    - Type (string) –
      
      The type of extension.
    - TypeName (string) –
      
      The name of the extension type to which this configuration applies.
- TypeConfigurations (list) –
  
  A list of any of the specified extension configurations from the CloudFormation registry.
  - (dict) –
    
    Detailed information concerning the specification of a CloudFormation extension in a given account and Region.
    
    For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
    - Alias (string) –
      
      The alias specified for this configuration, if one was specified when the configuration was set.
    - Configuration (string) –
      
      A JSON string specifying the configuration data for the extension, in this account and Region.
      
      If a configuration hasn’t been set for a specified extension, CloudFormation returns {}.
    - LastUpdated (datetime) –
      
      When the configuration data was last updated for this extension.
      
      If a configuration hasn’t been set for a specified extension, CloudFormation returns null.
    - TypeArn (string) –
      
      The Amazon Resource Name (ARN) for the extension, in this account and Region.
      
      For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.
    - TypeName (string) –
      
      The name of the extension.
    - IsDefaultConfiguration (boolean) –
      
      Whether this configuration data is the default configuration for the extension.

Exceptions

CloudFormation.Client.exceptions.TypeConfigurationNotFoundException
CloudFormation.Client.exceptions.CFNRegistryException