Omics / Client / list_configurations

list_configurations¶

Omics.Client.list_configurations(**kwargs)¶

List all configurations for the account.

Request Syntax

response = client.list_configurations(
    maxResults=123,
    startingToken='string'
)

Parameters:

maxResults (integer) – Maximum number of results to return.
startingToken (string) – Pagination token for retrieving next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
            'creationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  List of configuration items.
  - (dict) –
    
    Configuration list item with summary information.
    - arn (string) –
      
      Unique resource identifier for the configuration.
    - name (string) –
      
      User-friendly name for the configuration.
    - description (string) –
      
      Description for the configuration.
    - status (string) –
      
      Current configuration status.
    - creationTime (datetime) –
      
      Configuration creation timestamp.
- nextToken (string) –
  
  Token for retrieving next page of results.

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ServiceQuotaExceededException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ConflictException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException