describe-registrations¶

Description¶

Retrieves the specified registrations.

Synopsis¶

  describe-registrations
[--registration-ids <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--registration-ids (list)

An array of unique identifiers for each registration.

(string)

Syntax:

"string" "string" ...

--filters (list)

An array of RegistrationFilter objects to filter the results.

(structure)

The filter definition for filtering registrations that meets a specified criteria.

Name -> (string)

The name of the attribute to filter on.

Values -> (list)

An array of values to filter on.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "registration-type"|"registration-status",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

Registrations -> (list)

An array of RegistrationInformation objects.

(structure)

Provides information about the requested registration.

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. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

RegistrationStatus -> (string)

The status of the registration.

CREATED : Your registration is created but not submitted.

SUBMITTED : Your registration has been submitted and is awaiting review.

REVIEWING : Your registration has been accepted and is being reviewed.

PROVISIONING : Your registration has been approved and your origination identity is being created.

COMPLETE : Your registration has been approved and and your origination identity has been created.

REQUIRES_UPDATES : You must fix your registration and resubmit it.

CLOSED : The phone number or sender ID has been deleted and you must also delete the registration for the number.

DELETED : The registration has been deleted.

CurrentVersionNumber -> (long)

The current version number of the registration.

ApprovedVersionNumber -> (long)

The version number of the registration that was approved.

LatestDeniedVersionNumber -> (long)

The latest version number of the registration that was denied.

AdditionalAttributes -> (map)

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

key -> (string)

value -> (string)

CreatedTimestamp -> (timestamp)

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

NextToken -> (string)

The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

Table of Contents

Feedback

User Guide