ElementalInference / Client / list_feeds

list_feeds¶

ElementalInference.Client.list_feeds(**kwargs)¶

Displays a list of feeds that belong to this AWS account.

Request Syntax

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

Parameters:

maxResults (integer) –
The maximum number of results to return per API request.

For example, you submit a list request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.

Valid Range: Minimum value of 1. Maximum value of 1000.
nextToken (string) –
The token that identifies the batch of results that you want to see.

For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'feeds': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'association': {
                'associatedResourceName': 'string'
            },
            'status': 'CREATING'|'AVAILABLE'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'ARCHIVED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- feeds (list) –
  
  A list of feed summaries.
  - (dict) –
    
    Contains configuration information about a feed. It is used in the ListFeeds action.
    - arn (string) –
      
      The ARN of the feed.
    - id (string) –
      
      The ID of the feed.
    - name (string) –
      
      The name of the feed
    - association (dict) –
      
      The resource, if any, associated with the feed.
      - associatedResourceName (string) –
        
        The name of the associated resource.
    - status (string) –
      
      The status of the feed.
- nextToken (string) –
  
  The token that identifies the batch of results that you want to see. For example, you submit a list request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the list request a second time and specify the NextToken value.

Exceptions

ElementalInference.Client.exceptions.ValidationException
ElementalInference.Client.exceptions.ResourceNotFoundException
ElementalInference.Client.exceptions.InternalServerErrorException
ElementalInference.Client.exceptions.AccessDeniedException
ElementalInference.Client.exceptions.TooManyRequestException