[ aws . nimble ]

delete-streaming-image

Description

Delete streaming image.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  delete-streaming-image
[--client-token <value>]
--streaming-image-id <value>
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

--streaming-image-id (string)

The streaming image ID.

--studio-id (string)

The studio ID.

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

See ‘aws help’ for descriptions of global parameters.

Output

streamingImage -> (structure)

The streaming image.

arn -> (string)

The ARN of the resource.

description -> (string)

A human-readable description of the streaming image.

ec2ImageId -> (string)

The ID of an EC2 machine image with which to create the streaming image.

encryptionConfiguration -> (structure)

The encryption configuration.

keyArn -> (string)

The ARN for a KMS key that is used to encrypt studio data.

keyType -> (string)

The type of KMS key that is used to encrypt studio data.

eulaIds -> (list)

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

(string)

name -> (string)

A friendly name for a streaming image resource.

owner -> (string)

The owner of the streaming image, either the studioId that contains the streaming image, or ‘amazon’ for images that are provided by Amazon Nimble Studio.

platform -> (string)

The platform of the streaming image, either WINDOWS or LINUX.

state -> (string)

The current state.

statusCode -> (string)

The status code.

statusMessage -> (string)

The status message for the streaming image.

streamingImageId -> (string)

The ID of the streaming image.

tags -> (map)

A collection of labels, in the form of key:value pairs, that apply to this resource.

key -> (string)

value -> (string)