imagebuilder / Client / get_infrastructure_configuration

get_infrastructure_configuration

imagebuilder.Client.get_infrastructure_configuration(**kwargs)

Gets an infrastructure configuration.

See also: AWS API Documentation

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.

      • s3Logs (dict) –

        The Amazon S3 logging configuration.

        • s3BucketName (string) –

          The S3 bucket in which to store the logs.

        • s3KeyPrefix (string) –

          The Amazon S3 path to the bucket where the logs are stored.

    • keyPair (string) –

      The Amazon EC2 key pair of the infrastructure configuration.

    • terminateInstanceOnFailure (boolean) –

      The terminate instance on failure configuration of the infrastructure configuration.

    • snsTopicArn (string) –

      The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

      Note

      EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

    • 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 tags attached to the resource created by Image Builder.

      • (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.

        The default setting is optional.

      • httpPutResponseHopLimit (integer) –

        Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, 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 instances that are launched from your image will run.

      • 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. If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error.

      • 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. If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error.

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