AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appsync ]

create-channel-namespace

Description

Creates a ChannelNamespace for an Api .

See also: AWS API Documentation

Synopsis

  create-channel-namespace
--api-id <value>
--name <value>
[--subscribe-auth-modes <value>]
[--publish-auth-modes <value>]
[--code-handlers <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--api-id (string)

The Api ID.

--name (string)

The name of the ChannelNamespace . This name must be unique within the Api

--subscribe-auth-modes (list)

The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

Shorthand Syntax:

authType=string ...

JSON Syntax:

[
  {
    "authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
  }
  ...
]

--publish-auth-modes (list)

The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

Shorthand Syntax:

authType=string ...

JSON Syntax:

[
  {
    "authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
  }
  ...
]

--code-handlers (string)

The event handler functions that run custom business logic to process published events and subscribe requests.

--tags (map)

A map with keys of TagKey objects and values of TagValue objects.

key -> (string)

The key for the tag.

value -> (string)

The value for the tag.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

channelNamespace -> (structure)

The ChannelNamespace object.

apiId -> (string)

The Api ID.

name -> (string)

The name of the channel namespace. This name must be unique within the Api .

subscribeAuthModes -> (list)

The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

publishAuthModes -> (list)

The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

codeHandlers -> (string)

The event handler functions that run custom business logic to process published events and subscribe requests.

tags -> (map)

A map with keys of TagKey objects and values of TagValue objects.

key -> (string)

The key for the tag.

value -> (string)

The value for the tag.

channelNamespaceArn -> (string)

The Amazon Resource Name (ARN) for the ChannelNamespace .

created -> (timestamp)

The date and time that the ChannelNamespace was created.

lastModified -> (timestamp)

The date and time that the ChannelNamespace was last changed.