[ aws . partnercentral-selling ]

get-resource-snapshot-job

Description

Use this action to retrieves information about a specific resource snapshot job.

See also: AWS API Documentation

Synopsis

  get-resource-snapshot-job
--catalog <value>
--resource-snapshot-job-identifier <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]

Options

--catalog (string)

Specifies the catalog related to the request. Valid values are:

• AWS: Retrieves the snapshot job from the production AWS environment.
• Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes.

--resource-snapshot-job-identifier (string)

The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.

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

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

Arn -> (string)

he Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

Catalog -> (string)

The catalog in which the snapshot job was created. This will match the catalog specified in the request.

CreatedAt -> (timestamp)

The date and time when the snapshot job was created, in ISO 8601 format (UTC). Example: “2023-05-01T20:37:46Z”

EngagementId -> (string)

The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.

Id -> (string)

The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.

LastFailure -> (string)

If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

LastSuccessfulExecutionDate -> (timestamp)

The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: “2023-05-01T20:37:46Z”

ResourceArn -> (string)

The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

ResourceId -> (string)

The identifier of the specific resource being snapshotted. The format may vary depending on the ResourceType .

ResourceSnapshotTemplateName -> (string)

The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

ResourceType -> (string)

The type of resource being snapshotted. This would have Opportunity as a value as it is dependent on the supported resource type.

Status -> (string)

The current status of the snapshot job. Valid values:

• STOPPED: The job is not currently running.
• RUNNING: The job is actively executing.