AppFabric / Client / get_ingestion

get_ingestion#

AppFabric.Client.get_ingestion(**kwargs)#

Returns information about an ingestion.

Request Syntax

response = client.get_ingestion(
    appBundleIdentifier='string',
    ingestionIdentifier='string'
)

Parameters:

appBundleIdentifier (string) –
[REQUIRED]

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestionIdentifier (string) –
[REQUIRED]

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

Return type:

dict

Returns:

Response Syntax

{
    'ingestion': {
        'arn': 'string',
        'appBundleArn': 'string',
        'app': 'string',
        'tenantId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'state': 'enabled'|'disabled',
        'ingestionType': 'auditLog'
    }
}

Response Structure

(dict) –
- ingestion (dict) –
  
  Contains information about an ingestion.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the ingestion.
  - appBundleArn (string) –
    
    The Amazon Resource Name (ARN) of the app bundle for the ingestion.
  - app (string) –
    
    The name of the application.
  - tenantId (string) –
    
    The ID of the application tenant.
  - createdAt (datetime) –
    
    The timestamp of when the ingestion was created.
  - updatedAt (datetime) –
    
    The timestamp of when the ingestion was last updated.
  - state (string) –
    
    The status of the ingestion.
  - ingestionType (string) –
    
    The type of the ingestion.

Exceptions

AppFabric.Client.exceptions.InternalServerException
AppFabric.Client.exceptions.ThrottlingException
AppFabric.Client.exceptions.ValidationException
AppFabric.Client.exceptions.ResourceNotFoundException
AppFabric.Client.exceptions.AccessDeniedException