amazonka-workspaces-2.0: Amazon WorkSpaces SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkSpaces.CopyWorkspaceImage

Description

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.

In the China (Ningxia) Region, you can copy images only within the same Region.

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

Synopsis

Creating a Request

data CopyWorkspaceImage Source #

See: newCopyWorkspaceImage smart constructor.

Constructors

CopyWorkspaceImage' 

Fields

Instances

Instances details
ToJSON CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

ToHeaders CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

ToPath CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

ToQuery CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

AWSRequest CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

Associated Types

type AWSResponse CopyWorkspaceImage #

Generic CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

Associated Types

type Rep CopyWorkspaceImage :: Type -> Type #

Read CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

Show CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

NFData CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

Methods

rnf :: CopyWorkspaceImage -> () #

Eq CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

Hashable CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

type AWSResponse CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

type Rep CopyWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

type Rep CopyWorkspaceImage = D1 ('MetaData "CopyWorkspaceImage" "Amazonka.WorkSpaces.CopyWorkspaceImage" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "CopyWorkspaceImage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sourceImageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCopyWorkspaceImage Source #

Create a value of CopyWorkspaceImage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CopyWorkspaceImage, copyWorkspaceImage_description - A description of the image.

CopyWorkspaceImage, copyWorkspaceImage_tags - The tags for the image.

CopyWorkspaceImage, copyWorkspaceImage_name - The name of the image.

$sel:sourceImageId:CopyWorkspaceImage', copyWorkspaceImage_sourceImageId - The identifier of the source image.

$sel:sourceRegion:CopyWorkspaceImage', copyWorkspaceImage_sourceRegion - The identifier of the source Region.

Request Lenses

copyWorkspaceImage_sourceRegion :: Lens' CopyWorkspaceImage Text Source #

The identifier of the source Region.

Destructuring the Response

data CopyWorkspaceImageResponse Source #

See: newCopyWorkspaceImageResponse smart constructor.

Constructors

CopyWorkspaceImageResponse' 

Fields

Instances

Instances details
Generic CopyWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

Associated Types

type Rep CopyWorkspaceImageResponse :: Type -> Type #

Read CopyWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

Show CopyWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

NFData CopyWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

Eq CopyWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

type Rep CopyWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.CopyWorkspaceImage

type Rep CopyWorkspaceImageResponse = D1 ('MetaData "CopyWorkspaceImageResponse" "Amazonka.WorkSpaces.CopyWorkspaceImage" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "CopyWorkspaceImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCopyWorkspaceImageResponse Source #

Create a value of CopyWorkspaceImageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CopyWorkspaceImageResponse, copyWorkspaceImageResponse_imageId - The identifier of the image.

$sel:httpStatus:CopyWorkspaceImageResponse', copyWorkspaceImageResponse_httpStatus - The response's http status code.

Response Lenses