list-destination-endpoints¶

Description¶

Retrieves a list of the destination endpoints in your account. The results are paginated. Use the NextToken value that’s returned to retrieve additional results.

Synopsis¶

  list-destination-endpoints
[--filters <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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]
[--cli-error-format <value>]

Options¶

--filters (list)

The filters to apply to the list of destination endpoints.

(tagged union structure)

A filter to apply when listing destination endpoints. This is a union type, so exactly one of its members is set.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: RegionNames, DestinationTypes, NameContains.

RegionNames -> (list)

Filters the results to destination endpoints in the specified Amazon Web Services Regions.

(string)

DestinationTypes -> (list)

Filters the results to destination endpoints of the specified types.

(string)

Possible values:

STANDARD

ROUTER_INPUT

NameContains -> (list)

Filters the results to destination endpoints whose names contain the specified strings.

(string)

Shorthand Syntax:

RegionNames=string,string,DestinationTypes=string,string,NameContains=string,string ...

JSON Syntax:

[
  {
    "RegionNames": ["string", ...],
    "DestinationTypes": ["STANDARD"|"ROUTER_INPUT", ...],
    "NameContains": ["string", ...]
  }
  ...
]

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

Constraints:

min: 1

max: 100

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

--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. 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. 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
yaml
yaml-stream
off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

DestinationEndpoints -> (list)

The destination endpoints that match the request.

(structure)

A summary of a destination endpoint that the ListDestinationEndpoints operation returns.

Name -> (string) [required]

The name of the destination endpoint.

Arn -> (string) [required]

The Amazon Resource Name (ARN) of the destination endpoint.

Constraints:

min: 64

max: 128

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:destinationEndpoint:[a-z0-9]{12}

Id -> (string) [required]

The unique identifier of the destination endpoint.

DestinationType -> (string) [required]

The type of the destination endpoint. Valid values include the following:

STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.

ROUTER_INPUT – A destination endpoint that represents a router input.

Possible values:

STANDARD

ROUTER_INPUT

RegionName -> (string) [required]

The name of the Amazon Web Services Region in which the destination endpoint is located.

AvailabilityZone -> (string)

The Availability Zone in which the destination endpoint is located.

AvailabilityZoneId -> (string)

The ID of the Availability Zone in which the destination endpoint is located.

CreatedAt -> (timestamp) [required]

The date and time when the destination endpoint was created.

UpdatedAt -> (timestamp) [required]

The date and time when the destination endpoint was last updated.

LifecycleManagement -> (string) [required]

The entity that manages the lifecycle of the destination endpoint.

Possible values:

MANAGED

UNMANAGED

MessageCount -> (integer) [required]

The number of status messages for the destination endpoint.

ResourceShareOwnership -> (string) [required]

Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.

Possible values:

OWNED

CONSUMED

ResourceShareState -> (string) [required]

The sharing state of the destination endpoint.

Possible values:

SHARED

UNSHARED

RegistrationState -> (string) [required]

The registration state of the destination endpoint. Valid values include the following:

REGISTERED – The destination endpoint is registered and ready to use.

REGISTERING – MediaConnect is registering the destination endpoint.

DEREGISTERING – MediaConnect is deregistering the destination endpoint.

REGISTRATION_FAILED – MediaConnect couldn’t register the destination endpoint.

Possible values:

REGISTERED

REGISTERING

DEREGISTERING

REGISTRATION_FAILED

ConnectionState -> (string) [required]

The connection state of the destination endpoint. Valid values include the following:

CONNECTED – The destination endpoint is connected to a source endpoint.

DISCONNECTED – The destination endpoint isn’t connected to a source endpoint.

CONNECTING – The destination endpoint is connecting to a source endpoint.

DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.

Possible values:

CONNECTED

DISCONNECTED

CONNECTING

DISCONNECTING

DecryptionType -> (string)

The type of decryption used for the destination endpoint connection.

Possible values:

SECRETS_MANAGER

AUTOMATIC

ConnectedSource -> (string)

The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.

Constraints:

min: 64

max: 128

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:sourceEndpoint:[a-z0-9]{12}

AssociatedResourceArn -> (string)

The Amazon Resource Name (ARN) of the resource that is associated with the destination endpoint.

NextToken -> (string)

The token to use in the next request to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide