AppSync / Client / list_source_api_associations

list_source_api_associations#

AppSync.Client.list_source_api_associations(**kwargs)#

Lists the SourceApiAssociationSummary data.

See also: AWS API Documentation

Request Syntax

response = client.list_source_api_associations(
    apiId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • apiId (string) –

    [REQUIRED]

    The API ID.

  • nextToken (string) – An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • maxResults (integer) – The maximum number of results that you want the request to return.

Return type:

dict

Returns:

Response Syntax

{
    'sourceApiAssociationSummaries': [
        {
            'associationId': 'string',
            'associationArn': 'string',
            'sourceApiId': 'string',
            'sourceApiArn': 'string',
            'mergedApiId': 'string',
            'mergedApiArn': 'string',
            'description': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • sourceApiAssociationSummaries (list) –

      The SourceApiAssociationSummary object data.

      • (dict) –

        Describes the ARNs and IDs of associations, Merged APIs, and source APIs.

        • associationId (string) –

          The ID generated by the AppSync service for the source API association.

        • associationArn (string) –

          The Amazon Resource Name (ARN) of the source API association.

        • sourceApiId (string) –

          The ID of the AppSync source API.

        • sourceApiArn (string) –

          The Amazon Resource Name (ARN) of the AppSync Source API.

        • mergedApiId (string) –

          The ID of the AppSync Merged API.

        • mergedApiArn (string) –

          The Amazon Resource Name (ARN) of the AppSync Merged API.

        • description (string) –

          The description field.

    • nextToken (string) –

      An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Exceptions

  • AppSync.Client.exceptions.UnauthorizedException

  • AppSync.Client.exceptions.BadRequestException

  • AppSync.Client.exceptions.InternalFailureException

  • AppSync.Client.exceptions.NotFoundException