AppFabric / Client / list_ingestions

list_ingestions#

AppFabric.Client.list_ingestions(**kwargs)#

Returns a list of all ingestions configured for an app bundle.

Request Syntax

response = client.list_ingestions(
    appBundleIdentifier='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

appBundleIdentifier (string) –
[REQUIRED]

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
maxResults (integer) –
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
nextToken (string) – If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Return type:

dict

Returns:

Response Syntax

{
    'ingestions': [
        {
            'arn': 'string',
            'app': 'string',
            'tenantId': 'string',
            'state': 'enabled'|'disabled'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- ingestions (list) –
  
  Contains a list of ingestion summaries.
  - (dict) –
    
    Contains a summary of an ingestion.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the ingestion.
    - app (string) –
      
      The name of the application.
    - tenantId (string) –
      
      The ID of the application tenant.
    - state (string) –
      
      The status of the ingestion.
- nextToken (string) –
  
  If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Exceptions

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