list_applications

AppConfig.Client.list_applications(**kwargs)

Lists all applications in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
  • NextToken (string) -- A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.
Return type

dict

Returns

Response Syntax

{
    'Items': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Items (list) --

      The elements from this collection.

      • (dict) --

        • Id (string) --

          The application ID.

        • Name (string) --

          The application name.

        • Description (string) --

          The description of the application.

    • NextToken (string) --

      The token for the next set of items to return. Use this token to get the next set of results.

Exceptions

  • AppConfig.Client.exceptions.InternalServerException
  • AppConfig.Client.exceptions.BadRequestException

Examples

The following list-applications example lists the available applications in your AWS account.

response = client.list_applications(
)

print(response)

Expected Output:

{
    'Items': [
        {
            'Description': 'An application used for creating an example.',
            'Id': '339ohji',
            'Name': 'test-application',
        },
        {
            'Id': 'rwalwu7',
            'Name': 'Test-Application',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}