Connect / Client / list_extraction_definitions

list_extraction_definitions¶

Connect.Client.list_extraction_definitions(**kwargs)¶

Lists extraction definitions in the specified Connect Customer instance.

Request Syntax

response = client.list_extraction_definitions(
    InstanceId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

InstanceId (string) –
[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
MaxResults (integer) – The maximum number of results to return per page. The default MaxResult size is 100.
NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'ExtractionDefinitionSummaryList': [
        {
            'Name': 'string',
            'ExtractionDefinitionId': 'string',
            'ExtractionDefinitionArn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'LastUpdatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ExtractionDefinitionSummaryList (list) –
  
  Information about the extraction definitions.
  - (dict) –
    
    Summary information about an extraction definition.
    - Name (string) –
      
      The name of the extraction definition.
    - ExtractionDefinitionId (string) –
      
      The identifier of the extraction definition.
    - ExtractionDefinitionArn (string) –
      
      The Amazon Resource Name (ARN) of the extraction definition.
    - CreatedTime (datetime) –
      
      The timestamp when the extraction definition was created.
    - LastUpdatedTime (datetime) –
      
      The timestamp when the extraction definition was last updated.
    - LastUpdatedBy (string) –
      
      The Amazon Resource Name (ARN) of the user who last updated the extraction definition.
- NextToken (string) –
  
  If there are additional results, this is the token for the next set of results.

Exceptions

Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InternalServiceException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.AccessDeniedException
Connect.Client.exceptions.ResourceNotFoundException