imagebuilder / Client / get_infrastructure_configuration

get_infrastructure_configuration¶

imagebuilder.Client.get_infrastructure_configuration(**kwargs)¶

Retrieves an infrastructure configuration.

Request Syntax

response = client.get_infrastructure_configuration(
    infrastructureConfigurationArn='string'
)

Parameters:

infrastructureConfigurationArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'infrastructureConfiguration': {
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'instanceTypes': [
            'string',
        ],
        'instanceProfileName': 'string',
        'securityGroupIds': [
            'string',
        ],
        'subnetId': 'string',
        'logging': {
            's3Logs': {
                's3BucketName': 'string',
                's3KeyPrefix': 'string'
            }
        },
        'keyPair': 'string',
        'terminateInstanceOnFailure': True|False,
        'snsTopicArn': 'string',
        'dateCreated': 'string',
        'dateUpdated': 'string',
        'resourceTags': {
            'string': 'string'
        },
        'instanceMetadataOptions': {
            'httpTokens': 'string',
            'httpPutResponseHopLimit': 123
        },
        'tags': {
            'string': 'string'
        },
        'placement': {
            'availabilityZone': 'string',
            'tenancy': 'default'|'dedicated'|'host',
            'hostId': 'string',
            'hostResourceGroupArn': 'string'
        }
    }
}

Response Structure

(dict) –

GetInfrastructureConfiguration response object.
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- infrastructureConfiguration (dict) –
  
  The infrastructure configuration object.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the infrastructure configuration.
  - name (string) –
    
    The name of the infrastructure configuration.
  - description (string) –
    
    The description of the infrastructure configuration.
  - instanceTypes (list) –
    
    The instance types of the infrastructure configuration.
    - (string) –
  - instanceProfileName (string) –
    
    The instance profile of the infrastructure configuration.
  - securityGroupIds (list) –
    
    The security group IDs of the infrastructure configuration.
    - (string) –
  - subnetId (string) –
    
    The subnet ID of the infrastructure configuration.
  - logging (dict) –
    
    The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.
    - s3Logs (dict) –
      
      The Amazon S3 logging configuration.
      - s3BucketName (string) –
        
        The name of an existing Amazon S3 bucket where Image Builder saves build logs. The bucket isn’t validated when you create or update the configuration, and Image Builder doesn’t create it. The instance profile associated with this infrastructure configuration must have permission to write to the bucket.
      - s3KeyPrefix (string) –
        
        The Amazon S3 key prefix under which Image Builder writes build and test logs in the bucket.
  - keyPair (string) –
    
    The Amazon EC2 key pair of the infrastructure configuration.
  - terminateInstanceOnFailure (boolean) –
    
    Indicates whether Image Builder terminates the build and test instances when the image build fails. When false, Image Builder retains the instance so that you can debug it.
  - snsTopicArn (string) –
    
    The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn’t support FIFO topics.
    
    Note
    EC2 Image Builder can’t send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.
  - dateCreated (string) –
    
    The date on which the infrastructure configuration was created.
  - dateUpdated (string) –
    
    The date on which the infrastructure configuration was last updated.
  - resourceTags (dict) –
    
    The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder launches during image creation.
    - (string) –
      - (string) –
  - instanceMetadataOptions (dict) –
    
    The instance metadata option settings for the infrastructure configuration.
    - httpTokens (string) –
      
      Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:
      - required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
      - optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.
      If you don’t set a value, the EC2 launch default applies to the build and test instances. That default depends on the base AMI and any account-level instance metadata defaults. For more information, see Configure the instance metadata options in the Amazon EC2 User Guide .
    - httpPutResponseHopLimit (integer) –
      
      Limit the number of hops that an instance metadata request can traverse to reach its destination. If you don’t set a value, the EC2 launch default for the instance applies. If HTTP tokens are required, container image builds need a minimum of two hops.
  - tags (dict) –
    
    The tags of the infrastructure configuration.
    - (string) –
      - (string) –
  - placement (dict) –
    
    The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don’t affect instances that you launch from the output image.
    - availabilityZone (string) –
      
      The Availability Zone where your build and test instances will launch.
    - tenancy (string) –
      
      The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware. An instance with a tenancy of host runs on a Dedicated Host.
      
      If tenancy is set to host, then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don’t specify any placement target, Amazon EC2 will try to find an available host for your build and test instances.
    - hostId (string) –
      
      The ID of the Dedicated Host on which build and test instances run. This only applies if tenancy is host.
    - hostResourceGroupArn (string) –
      
      The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if tenancy is host.

Exceptions

imagebuilder.Client.exceptions.ServiceException
imagebuilder.Client.exceptions.ClientException
imagebuilder.Client.exceptions.ServiceUnavailableException
imagebuilder.Client.exceptions.InvalidRequestException
imagebuilder.Client.exceptions.ForbiddenException
imagebuilder.Client.exceptions.CallRateLimitExceededException