imagebuilder / Client / list_infrastructure_configurations

list_infrastructure_configurations¶

imagebuilder.Client.list_infrastructure_configurations(**kwargs)¶

Returns a list of infrastructure configurations.

Request Syntax

response = client.list_infrastructure_configurations(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

filters (list) –
You can filter on name to streamline results.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  - name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - values (list) –
    
    The filter values. Filter values are case-sensitive.
    - (string) –
maxResults (integer) – The maximum number of items to return in a single request.
nextToken (string) – A token to specify where to start paginating. Use the nextToken value from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'infrastructureConfigurationSummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'dateCreated': 'string',
            'dateUpdated': 'string',
            'resourceTags': {
                'string': 'string'
            },
            'tags': {
                'string': 'string'
            },
            'instanceTypes': [
                'string',
            ],
            'instanceProfileName': 'string',
            'placement': {
                'availabilityZone': 'string',
                'tenancy': 'default'|'dedicated'|'host',
                'hostId': 'string',
                'hostResourceGroupArn': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- infrastructureConfigurationSummaryList (list) –
  
  The list of infrastructure configurations.
  - (dict) –
    
    Contains a high-level summary of an infrastructure configuration, including the environment settings that Image Builder uses to build and test images.
    - 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.
    - 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) –
    - tags (dict) –
      
      The tags of the infrastructure configuration.
      - (string) –
        
        (string) –
    - instanceTypes (list) –
      
      The instance types of the infrastructure configuration.
      - (string) –
    - instanceProfileName (string) –
      
      The instance profile of the infrastructure configuration.
    - 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.
- nextToken (string) –
  
  The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

Exceptions

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