AppSync / Client / associate_api

associate_api#

AppSync.Client.associate_api(**kwargs)#

Maps an endpoint to your custom domain.

See also: AWS API Documentation

Request Syntax

response = client.associate_api(
    domainName='string',
    apiId='string'
)
Parameters:

  • domainName (string) –

    [REQUIRED]

    The domain name.

  • apiId (string) –

    [REQUIRED]

    The API ID. Private APIs can not be associated with custom domains.

Return type:

dict

Returns:

Response Syntax

{
    'apiAssociation': {
        'domainName': 'string',
        'apiId': 'string',
        'associationStatus': 'PROCESSING'|'FAILED'|'SUCCESS',
        'deploymentDetail': 'string'
    }
}

Response Structure

  • (dict) –

    • apiAssociation (dict) –

      The ApiAssociation object.

      • domainName (string) –

        The domain name.

      • apiId (string) –

        The API ID.

      • associationStatus (string) –

        Identifies the status of an association.

        • PROCESSING: The API association is being created. You cannot modify association requests during processing.

        • SUCCESS: The API association was successful. You can modify associations after success.

        • FAILED: The API association has failed. You can modify associations after failure.

      • deploymentDetail (string) –

        Details about the last deployment status.

Exceptions