Omics / Client / get_configuration

get_configuration¶

Omics.Client.get_configuration(**kwargs)¶

Retrieve configuration details for specified name.

Request Syntax

response = client.get_configuration(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

Configuration name to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'uuid': 'string',
    'name': 'string',
    'description': 'string',
    'runConfigurations': {
        'vpcConfig': {
            'securityGroupIds': [
                'string',
            ],
            'subnetIds': [
                'string',
            ],
            'vpcId': 'string'
        }
    },
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- arn (string) –
  
  Unique resource identifier for the configuration.
- uuid (string) –
  
  Unique identifier for the configuration.
- name (string) –
  
  User-friendly name for the configuration.
- description (string) –
  
  Description for the configuration.
- runConfigurations (dict) –
  
  Run-specific configurations.
  - vpcConfig (dict) –
    
    VPC configuration for workflow runs with computed VPC ID.
    - securityGroupIds (list) –
      
      List of security group IDs.
      - (string) –
    - subnetIds (list) –
      
      List of subnet IDs.
      - (string) –
    - vpcId (string) –
      
      VPC ID computed from the provided subnet IDs.
- status (string) –
  
  Current configuration status.
- creationTime (datetime) –
  
  Configuration creation timestamp.
- tags (dict) –
  
  Tags for the configuration.
  - (string) –
    - (string) –

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