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 . pinpoint-sms-voice-v2 ]

create-registration

Description

Creates a new registration based on the RegistrationType field.

See also: AWS API Documentation

Synopsis

  create-registration
--registration-type <value>
[--tags <value>]
[--client-token <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

--registration-type (string)

The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

--tags (list)

An array of tags (key and value pairs) to associate with the registration.

(structure)

The list of tags to be added to the specified topic.

Key -> (string)

The key identifier, or name, of the tag.

Value -> (string)

The string value associated with the key of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

--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

RegistrationArn -> (string)

The Amazon Resource Name (ARN) for the registration.

RegistrationId -> (string)

The unique identifier for the registration.

RegistrationType -> (string)

The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

RegistrationStatus -> (string)

The status of the registration.

  • CLOSED : The phone number or sender ID has been deleted and you must also delete the registration for the number.
  • CREATED : Your registration is created but not submitted.
  • COMPLETE : Your registration has been approved and your origination identity has been created.
  • DELETED : The registration has been deleted.
  • PROVISIONING : Your registration has been approved and your origination identity is being created.
  • REQUIRES_AUTHENTICATION : You need to complete email authentication.
  • REQUIRES_UPDATES : You must fix your registration and resubmit it.
  • REVIEWING : Your registration has been accepted and is being reviewed.
  • SUBMITTED : Your registration has been submitted and is awaiting review.

CurrentVersionNumber -> (long)

The current version number of the registration.

AdditionalAttributes -> (map)

Metadata about a given registration which is specific to that registration type.

key -> (string)

value -> (string)

Tags -> (list)

An array of tags (key and value pairs) to associate with the registration.

(structure)

The list of tags to be added to the specified topic.

Key -> (string)

The key identifier, or name, of the tag.

Value -> (string)

The string value associated with the key of the tag.

CreatedTimestamp -> (timestamp)

The time when the registration was created, in UNIX epoch time format.