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

get-signal-map

Description

Retrieves the specified signal map.

See also: AWS API Documentation

Synopsis

  get-signal-map
--identifier <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

--identifier (string) A signal map's identifier. Can be either be its id or current name.

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

Arn -> (string)

A signal map's ARN (Amazon Resource Name)

CloudWatchAlarmTemplateGroupIds -> (list)

Placeholder documentation for __listOf__stringMin7Max11PatternAws097

(string)

Placeholder documentation for __stringMin7Max11PatternAws097

CreatedAt -> (timestamp)

Placeholder documentation for __timestampIso8601

Description -> (string)

A resource's optional description.

DiscoveryEntryPointArn -> (string)

A top-level supported AWS resource ARN to discovery a signal map from.

ErrorMessage -> (string)

Error message associated with a failed creation or failed update attempt of a signal map.

EventBridgeRuleTemplateGroupIds -> (list)

Placeholder documentation for __listOf__stringMin7Max11PatternAws097

(string)

Placeholder documentation for __stringMin7Max11PatternAws097

FailedMediaResourceMap -> (map)

A map representing an incomplete AWS media workflow as a graph.

key -> (string)

Placeholder documentation for __string

value -> (structure)

An AWS resource used in media workflows.

Destinations -> (list)

Placeholder documentation for __listOfMediaResourceNeighbor

(structure)

A direct source or destination neighbor to an AWS media resource.

Arn -> (string)

The ARN of a resource used in AWS media workflows.

Name -> (string)

The logical name of an AWS media resource.

Name -> (string)

The logical name of an AWS media resource.

Sources -> (list)

Placeholder documentation for __listOfMediaResourceNeighbor

(structure)

A direct source or destination neighbor to an AWS media resource.

Arn -> (string)

The ARN of a resource used in AWS media workflows.

Name -> (string)

The logical name of an AWS media resource.

Id -> (string)

A signal map's id.

LastDiscoveredAt -> (timestamp)

Placeholder documentation for __timestampIso8601

LastSuccessfulMonitorDeployment -> (structure)

Represents the latest successful monitor deployment of a signal map.

DetailsUri -> (string)

URI associated with a signal map's monitor deployment.

Status -> (string)

A signal map's monitor deployment status.

MediaResourceMap -> (map)

A map representing an AWS media workflow as a graph.

key -> (string)

Placeholder documentation for __string

value -> (structure)

An AWS resource used in media workflows.

Destinations -> (list)

Placeholder documentation for __listOfMediaResourceNeighbor

(structure)

A direct source or destination neighbor to an AWS media resource.

Arn -> (string)

The ARN of a resource used in AWS media workflows.

Name -> (string)

The logical name of an AWS media resource.

Name -> (string)

The logical name of an AWS media resource.

Sources -> (list)

Placeholder documentation for __listOfMediaResourceNeighbor

(structure)

A direct source or destination neighbor to an AWS media resource.

Arn -> (string)

The ARN of a resource used in AWS media workflows.

Name -> (string)

The logical name of an AWS media resource.

ModifiedAt -> (timestamp)

Placeholder documentation for __timestampIso8601

MonitorChangesPendingDeployment -> (boolean)

If true, there are pending monitor changes for this signal map that can be deployed.

MonitorDeployment -> (structure)

Represents the latest monitor deployment of a signal map.

DetailsUri -> (string)

URI associated with a signal map's monitor deployment.

ErrorMessage -> (string)

Error message associated with a failed monitor deployment of a signal map.

Status -> (string)

A signal map's monitor deployment status.

Name -> (string)

A resource's name. Names must be unique within the scope of a resource type in a specific region.

Status -> (string)

A signal map's current status which is dependent on its lifecycle actions or associated jobs.

Tags -> (map)

Represents the tags associated with a resource.

key -> (string)

Placeholder documentation for __string

value -> (string)

Placeholder documentation for __string