AWS CLI Command Reference

[ aws . mediaconnect ]

batch-get-destination-endpoint

Description

Retrieves information about multiple destination endpoints in a single request.

See also: AWS API Documentation

Synopsis

  batch-get-destination-endpoint
--arns <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

--arns (list) [required]

The Amazon Resource Names (ARNs) of one or more destination endpoints to retrieve. You can specify from 1 to 20 ARNs.

Constraints:

  • min: 1
  • max: 20

(string)

Constraints:

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

Syntax:

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

--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 MediaConnect successfully retrieved.

(structure)

The details of a destination endpoint in MediaConnect, including its configuration, state, and connection details.

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.

Description -> (string) [required]

The description of the destination endpoint.

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

Messages -> (list) [required]

The status messages for the destination endpoint.

(structure)

A status message for a destination endpoint.

Code -> (string) [required]

The message code.

Message -> (string) [required]

The message text.

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

Configuration -> (tagged union structure) [required]

The configuration settings for the destination endpoint.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, RouterInput.

Standard -> (structure)

The configuration settings for a standard destination endpoint, which represents an external destination.

Name -> (string) [required]

The name of the destination endpoint.

Constraints:

  • min: 1
  • max: 164
  • pattern: [a-zA-Z0-9]([a-zA-Z0-9\-_]*[a-zA-Z0-9])?

DestinationNetworkingConfiguration -> (tagged union structure) [required]

The networking configuration for the destination endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Public, Vpc.

Public -> (structure)

The configuration for a publicly accessible destination endpoint.

DestinationAllowRules -> (list) [required]

The rules that specify which CIDR blocks can connect to the destination endpoint. You can specify up to 10 rules.

Constraints:

  • min: 0
  • max: 10

(structure)

A rule that allows a specific CIDR block to connect to the public destination endpoint.

Cidr -> (string) [required]

The CIDR block that is allowed to connect to the destination endpoint, in CIDR notation.

Constraints:

  • pattern: (?:[0-9]{1,3}\.){3}[0-9]{1,3}/([0-9]|[12][0-9]|3[0-2])

Vpc -> (structure)

The configuration for a destination endpoint in a virtual private cloud (VPC).

SecurityGroupIds -> (list) [required]

The IDs of the security groups to associate with the destination endpoint. You can specify from 1 to 5 security groups.

Constraints:

  • min: 1
  • max: 5

(string)

SubnetId -> (string) [required]

The ID of the subnet to use for the destination endpoint.

ProtocolConfiguration -> (tagged union structure) [required]

The protocol configuration for the destination endpoint.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.

Rist -> (structure)

The configuration settings for a destination endpoint that uses the RIST protocol.

DestinationAddress -> (string) [required]

The IP address on which the destination endpoint receives content.

DestinationIngestPort -> (integer) [required]

The port on which the destination endpoint receives content. The valid range is 1024 to 65531.

Constraints:

  • min: 1024
  • max: 65531

SrtListener -> (structure)

The configuration settings for a destination endpoint that uses SRT in listener mode.

DestinationAddress -> (string) [required]

The IP address on which the destination endpoint listens for incoming connections.

DestinationIngestPort -> (integer) [required]

The port on which the destination endpoint listens for incoming connections. The valid range is 0 to 65531.

Constraints:

  • min: 0
  • max: 65531

MinimumLatencyMilliseconds -> (long) [required]

The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.

Constraints:

  • min: 10
  • max: 10000

StreamId -> (string)

The stream ID that identifies the content for the SRT connection.

EncryptionPassphrase -> (structure)

The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.

SecretArn -> (string) [required]

The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager . The secret must be in the same Amazon Web Services account and Region as the endpoint.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

SrtCaller -> (structure)

The configuration settings for a destination endpoint that uses SRT in caller mode.

SourceListenerPort -> (integer) [required]

The port on which the source listens for the connection. The valid range is 3000 to 30000.

Constraints:

  • min: 3000
  • max: 30000

MinimumLatencyMilliseconds -> (long) [required]

The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.

Constraints:

  • min: 10
  • max: 10000

EncryptionPassphrase -> (structure)

The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.

SecretArn -> (string) [required]

The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager . The secret must be in the same Amazon Web Services account and Region as the endpoint.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

Rtp -> (structure)

The configuration settings for a destination endpoint that uses the RTP protocol.

DestinationAddress -> (string) [required]

The IP address on which the destination endpoint receives content.

DestinationIngestPort -> (integer) [required]

The port on which the destination endpoint receives content. The valid range is 1024 to 65531.

Constraints:

  • min: 1024
  • max: 65531

ForwardErrorCorrectionState -> (string) [required]

Indicates whether forward error correction (FEC) is enabled for the destination endpoint.

Possible values:

  • ENABLED
  • DISABLED

DestinationNetworkingType -> (string)

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

  • PUBLIC – The destination endpoint is publicly accessible.
  • VPC – The destination endpoint is in a virtual private cloud (VPC).

Possible values:

  • PUBLIC
  • VPC

Protocol -> (string)

The protocol used by the destination endpoint. Valid values include the following:

  • RTP – Real-time Transport Protocol.
  • RIST – Reliable Internet Stream Transport.
  • SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
  • SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.

Possible values:

  • RTP
  • RIST
  • SRT_CALLER
  • SRT_LISTENER

RouterInput -> (structure)

The configuration settings for a destination endpoint that represents a router input.

RouterInputArn -> (string) [required]

The Amazon Resource Name (ARN) of the router input that the destination endpoint represents.

Constraints:

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

ResourceShareOwnership -> (string) [required]

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

Possible values:

  • OWNED
  • CONSUMED

ResourceShareDetails -> (tagged union structure) [required]

The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Owned, Consumed.

Owned -> (structure)

The sharing details for an endpoint that this account owns and shares with other accounts through RAM.

ShareState -> (string) [required]

The sharing state of the endpoint. Valid values include the following:

  • SHARED – The endpoint is shared with one or more accounts.
  • UNSHARED – The endpoint is not shared with other accounts.

Possible values:

  • SHARED
  • UNSHARED

Consumed -> (structure)

The sharing details for an endpoint that another account shares with this account through RAM.

OwnerAccountId -> (string) [required]

The ID of the Amazon Web Services account that owns the shared endpoint.

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

ConnectionDetails -> (tagged union structure)

The connection details for the destination endpoint.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, RouterInput.

Standard -> (structure)

The connection details for a standard destination endpoint.

SourceIpAddress -> (string)

The IP address of the source that is connected to the destination endpoint.

SourceListenerPort -> (integer)

The port on which the source listens for the connection.

SourceEncryptionType -> (string)

The type of encryption that the source uses for the connection.

Possible values:

  • SECRETS_MANAGER
  • AUTOMATIC

SourceEncryptionConfiguration -> (tagged union structure)

The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.

SecretsManager -> (structure)

The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.

EncryptionSecretType -> (string)

The type of secret used to encrypt the connection. Valid values include the following:

  • AES_128_KEY – A 128-bit AES encryption key.
  • AES_192_KEY – A 192-bit AES encryption key.
  • AES_256_KEY – A 256-bit AES encryption key.
  • SRT_PASSPHRASE – An SRT passphrase.

Possible values:

  • AES_128_KEY
  • AES_192_KEY
  • AES_256_KEY
  • SRT_PASSPHRASE

EncryptionSecret -> (structure) [required]

The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.

SecretArn -> (string) [required]

The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager . The secret must be in the same Amazon Web Services account and Region as the endpoint.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

Automatic -> (structure)

The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.

SourceEndpointType -> (string)

The type of the connected source endpoint.

Possible values:

  • STANDARD
  • ROUTER_OUTPUT

RouterInput -> (structure)

The connection details for a destination endpoint that represents a router input.

SourceEncryptionType -> (string)

The type of encryption that the source uses for the connection.

Possible values:

  • SECRETS_MANAGER
  • AUTOMATIC

SourceEncryptionConfiguration -> (tagged union structure)

The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.

SecretsManager -> (structure)

The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.

EncryptionSecretType -> (string)

The type of secret used to encrypt the connection. Valid values include the following:

  • AES_128_KEY – A 128-bit AES encryption key.
  • AES_192_KEY – A 192-bit AES encryption key.
  • AES_256_KEY – A 256-bit AES encryption key.
  • SRT_PASSPHRASE – An SRT passphrase.

Possible values:

  • AES_128_KEY
  • AES_192_KEY
  • AES_256_KEY
  • SRT_PASSPHRASE

EncryptionSecret -> (structure) [required]

The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.

SecretArn -> (string) [required]

The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager . The secret must be in the same Amazon Web Services account and Region as the endpoint.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

Automatic -> (structure)

The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.

SourceEndpointType -> (string)

The type of the connected source endpoint.

Possible values:

  • STANDARD
  • ROUTER_OUTPUT

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

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}

DecryptionType -> (string)

The type of decryption used for the destination endpoint connection.

Possible values:

  • SECRETS_MANAGER
  • AUTOMATIC

DecryptionConfiguration -> (tagged union structure)

The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.

SecretsManager -> (structure)

The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.

EncryptionSecretType -> (string)

The type of secret used to encrypt the connection. Valid values include the following:

  • AES_128_KEY – A 128-bit AES encryption key.
  • AES_192_KEY – A 192-bit AES encryption key.
  • AES_256_KEY – A 256-bit AES encryption key.
  • SRT_PASSPHRASE – An SRT passphrase.

Possible values:

  • AES_128_KEY
  • AES_192_KEY
  • AES_256_KEY
  • SRT_PASSPHRASE

EncryptionSecret -> (structure) [required]

The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.

SecretArn -> (string) [required]

The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager . The secret must be in the same Amazon Web Services account and Region as the endpoint.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

Automatic -> (structure)

The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.

AssociatedResourceDetails -> (tagged union structure) [required]

The details of the resource that is associated with the destination endpoint.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, RouterInput.

Standard -> (structure)

The associated resource details for a standard destination endpoint.

RouterInput -> (structure)

The associated resource details for a destination endpoint that represents a router input.

Name -> (string) [required]

The name of the router input.

MaximumBitrate -> (long) [required]

The maximum bitrate of the router input, in bits per second.

State -> (string) [required]

The state of the router input.

Possible values:

  • CREATING
  • STANDBY
  • STARTING
  • ACTIVE
  • STOPPING
  • DELETING
  • UPDATING
  • ERROR
  • RECOVERING
  • MIGRATING

Messages -> (list) [required]

The status messages for the router input.

(structure)

A message associated with a router input, including a code and a message.

Code -> (string) [required]

The code associated with the router input message.

Message -> (string) [required]

The message text associated with the router input message.

Tags -> (map) [required]

The tags associated with the destination endpoint. Each tag is a key-value pair.

key -> (string)

value -> (string)

Errors -> (list)

The errors for any destination endpoints that MediaConnect couldn’t retrieve.

(structure)

An error for a destination endpoint that MediaConnect couldn’t retrieve in a BatchGetDestinationEndpoint request.

Arn -> (string) [required]

The Amazon Resource Name (ARN) of the destination endpoint that MediaConnect couldn’t retrieve.

Constraints:

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

Code -> (string) [required]

The error code.

Message -> (string) [required]

A description of the error.
© Copyright 2026, Amazon Web Services. Created using Sphinx.