[ aws . appsync ]

associate-api

Description

Maps an endpoint to your custom domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  associate-api
--domain-name <value>
--api-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

The domain name.

--api-id (string)

The API ID.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

apiAssociation -> (structure)

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.