imagebuilder / Client / list_distribution_configurations

list_distribution_configurations#

imagebuilder.Client.list_distribution_configurations(**kwargs)#

Returns a list of distribution configurations.

Request Syntax

response = client.list_distribution_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 items to return in a request.
nextToken (string) – A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'distributionConfigurationSummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'dateCreated': 'string',
            'dateUpdated': 'string',
            'tags': {
                'string': 'string'
            },
            'regions': [
                'string',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- distributionConfigurationSummaryList (list) –
  
  The list of distributions.
  - (dict) –
    
    A high-level overview of a distribution configuration.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the distribution configuration.
    - name (string) –
      
      The name of the distribution configuration.
    - description (string) –
      
      The description of the distribution configuration.
    - dateCreated (string) –
      
      The date on which the distribution configuration was created.
    - dateUpdated (string) –
      
      The date on which the distribution configuration was updated.
    - tags (dict) –
      
      The tags associated with the distribution configuration.
      - (string) –
        
        (string) –
    - regions (list) –
      
      A list of Regions where the container image is distributed to.
      - (string) –
- 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