get_apps

Pinpoint.Client.get_apps(**kwargs)

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

See also: AWS API Documentation

Request Syntax

response = client.get_apps(
    PageSize='string',
    Token='string'
)

Parameters

• PageSize (string) -- The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• Token (string) -- The NextToken string that specifies which page of results to return in a paginated response.

Return type

dict

Returns

Response Syntax

{
    'ApplicationsResponse': {
        'Item': [
            {
                'Arn': 'string',
                'Id': 'string',
                'Name': 'string',
                'tags': {
                    'string': 'string'
                },
                'CreationDate': 'string'
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

• (dict) --

  The request succeeded.

  • ApplicationsResponse (dict) --

    Provides information about all of your applications.

    • Item (list) --

      An array of responses, one for each application that was returned.

      • (dict) --

        Provides information about an application.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the application.

        • Id (string) --

          The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

        • Name (string) --

          The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

        • tags (dict) --

          A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

          • (string) --
            • (string) --

        • CreationDate (string) --

          The date and time when the Application was created.

    • NextToken (string) --

      The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Exceptions

• Pinpoint.Client.exceptions.BadRequestException
• Pinpoint.Client.exceptions.InternalServerErrorException
• Pinpoint.Client.exceptions.PayloadTooLargeException
• Pinpoint.Client.exceptions.ForbiddenException
• Pinpoint.Client.exceptions.NotFoundException
• Pinpoint.Client.exceptions.MethodNotAllowedException
• Pinpoint.Client.exceptions.TooManyRequestsException