Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ImageBuilder.ImportComponent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Imports a component and transforms its data into a component document.

Synopsis

data ImportComponent = ImportComponent' {
- changeDescription :: Maybe Text
- data' :: Maybe Text
- description :: Maybe Text
- kmsKeyId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- uri :: Maybe Text
- name :: Text
- semanticVersion :: Text
- type' :: ComponentType
- format :: ComponentFormat
- platform :: Platform
- clientToken :: Text
}
newImportComponent :: Text -> Text -> ComponentType -> ComponentFormat -> Platform -> Text -> ImportComponent
importComponent_changeDescription :: Lens' ImportComponent (Maybe Text)
importComponent_data :: Lens' ImportComponent (Maybe Text)
importComponent_description :: Lens' ImportComponent (Maybe Text)
importComponent_kmsKeyId :: Lens' ImportComponent (Maybe Text)
importComponent_tags :: Lens' ImportComponent (Maybe (HashMap Text Text))
importComponent_uri :: Lens' ImportComponent (Maybe Text)
importComponent_name :: Lens' ImportComponent Text
importComponent_semanticVersion :: Lens' ImportComponent Text
importComponent_type :: Lens' ImportComponent ComponentType
importComponent_format :: Lens' ImportComponent ComponentFormat
importComponent_platform :: Lens' ImportComponent Platform
importComponent_clientToken :: Lens' ImportComponent Text
data ImportComponentResponse = ImportComponentResponse' {
- clientToken :: Maybe Text
- componentBuildVersionArn :: Maybe Text
- requestId :: Maybe Text
- httpStatus :: Int
}
newImportComponentResponse :: Int -> ImportComponentResponse
importComponentResponse_clientToken :: Lens' ImportComponentResponse (Maybe Text)
importComponentResponse_componentBuildVersionArn :: Lens' ImportComponentResponse (Maybe Text)
importComponentResponse_requestId :: Lens' ImportComponentResponse (Maybe Text)
importComponentResponse_httpStatus :: Lens' ImportComponentResponse Int

Creating a Request

data ImportComponent Source #

See: newImportComponent smart constructor.

Constructors

ImportComponent'

Fields

changeDescription :: Maybe Text
The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.
data' :: Maybe Text
The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.
description :: Maybe Text
The description of the component. Describes the contents of the component.
kmsKeyId :: Maybe Text
The ID of the KMS key that should be used to encrypt this component.
tags :: Maybe (HashMap Text Text)
The tags of the component.
uri :: Maybe Text
The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
name :: Text
The name of the component.
semanticVersion :: Text
The semantic version of the component. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
type' :: ComponentType
The type of the component denotes whether the component is used to build the image, or only to test it.
format :: ComponentFormat
The format of the resource that you want to import as a component.
platform :: Platform
The platform of the component.
clientToken :: Text
The idempotency token of the component.

Instances

Instances details

ToJSON ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods toJSON :: ImportComponent -> Value # toEncoding :: ImportComponent -> Encoding # toJSONList :: [ImportComponent] -> Value # toEncodingList :: [ImportComponent] -> Encoding #
ToHeaders ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods toHeaders :: ImportComponent -> [Header] #
ToPath ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods toPath :: ImportComponent -> ByteString #
ToQuery ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods toQuery :: ImportComponent -> QueryString #
AWSRequest ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Associated Types type AWSResponse ImportComponent # Methods request :: (Service -> Service) -> ImportComponent -> Request ImportComponent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportComponent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportComponent))) #
Generic ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Associated Types type Rep ImportComponent :: Type -> Type # Methods from :: ImportComponent -> Rep ImportComponent x # to :: Rep ImportComponent x -> ImportComponent #
Read ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods readsPrec :: Int -> ReadS ImportComponent # readList :: ReadS [ImportComponent] # readPrec :: ReadPrec ImportComponent # readListPrec :: ReadPrec [ImportComponent] #
Show ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods showsPrec :: Int -> ImportComponent -> ShowS # show :: ImportComponent -> String # showList :: [ImportComponent] -> ShowS #
NFData ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods rnf :: ImportComponent -> () #
Eq ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods (==) :: ImportComponent -> ImportComponent -> Bool # (/=) :: ImportComponent -> ImportComponent -> Bool #
Hashable ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods hashWithSalt :: Int -> ImportComponent -> Int # hash :: ImportComponent -> Int #
type AWSResponse ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent type AWSResponse ImportComponent = ImportComponentResponse
type Rep ImportComponent Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent type Rep ImportComponent = D1 ('MetaData "ImportComponent" "Amazonka.ImageBuilder.ImportComponent" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "ImportComponent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "changeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "semanticVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ComponentType))) :: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ComponentFormat) :: (S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Platform) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newImportComponent Source #

Arguments

:: Text	`ImportComponent`
-> Text	`$sel:semanticVersion:ImportComponent'`
-> ComponentType	`ImportComponent`
-> ComponentFormat	`$sel:format:ImportComponent'`
-> Platform	`ImportComponent`
-> Text	`ImportComponent`
-> ImportComponent

Create a value of ImportComponent 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:

ImportComponent, importComponent_changeDescription - The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

ImportComponent, importComponent_data - The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

ImportComponent, importComponent_description - The description of the component. Describes the contents of the component.

ImportComponent, importComponent_kmsKeyId - The ID of the KMS key that should be used to encrypt this component.

ImportComponent, importComponent_tags - The tags of the component.

$sel:uri:ImportComponent', importComponent_uri - The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

ImportComponent, importComponent_name - The name of the component.

$sel:semanticVersion:ImportComponent', importComponent_semanticVersion - The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

ImportComponent, importComponent_type - The type of the component denotes whether the component is used to build the image, or only to test it.

$sel:format:ImportComponent', importComponent_format - The format of the resource that you want to import as a component.

ImportComponent, importComponent_platform - The platform of the component.

ImportComponent, importComponent_clientToken - The idempotency token of the component.

Request Lenses

importComponent_changeDescription :: Lens' ImportComponent (Maybe Text) Source #

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

importComponent_data :: Lens' ImportComponent (Maybe Text) Source #

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

importComponent_description :: Lens' ImportComponent (Maybe Text) Source #

The description of the component. Describes the contents of the component.

importComponent_kmsKeyId :: Lens' ImportComponent (Maybe Text) Source #

The ID of the KMS key that should be used to encrypt this component.

importComponent_tags :: Lens' ImportComponent (Maybe (HashMap Text Text)) Source #

The tags of the component.

importComponent_uri :: Lens' ImportComponent (Maybe Text) Source #

The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

importComponent_name :: Lens' ImportComponent Text Source #

The name of the component.

importComponent_semanticVersion :: Lens' ImportComponent Text Source #

The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

importComponent_type :: Lens' ImportComponent ComponentType Source #

The type of the component denotes whether the component is used to build the image, or only to test it.

importComponent_format :: Lens' ImportComponent ComponentFormat Source #

The format of the resource that you want to import as a component.

importComponent_platform :: Lens' ImportComponent Platform Source #

The platform of the component.

importComponent_clientToken :: Lens' ImportComponent Text Source #

The idempotency token of the component.

Destructuring the Response

data ImportComponentResponse Source #

See: newImportComponentResponse smart constructor.

Constructors

ImportComponentResponse'
Fields clientToken :: Maybe Text The idempotency token used to make this request idempotent. componentBuildVersionArn :: Maybe Text The Amazon Resource Name (ARN) of the imported component. requestId :: Maybe Text The request ID that uniquely identifies this request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ImportComponentResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Associated Types type Rep ImportComponentResponse :: Type -> Type # Methods from :: ImportComponentResponse -> Rep ImportComponentResponse x # to :: Rep ImportComponentResponse x -> ImportComponentResponse #
Read ImportComponentResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods readsPrec :: Int -> ReadS ImportComponentResponse # readList :: ReadS [ImportComponentResponse] # readPrec :: ReadPrec ImportComponentResponse # readListPrec :: ReadPrec [ImportComponentResponse] #
Show ImportComponentResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods showsPrec :: Int -> ImportComponentResponse -> ShowS # show :: ImportComponentResponse -> String # showList :: [ImportComponentResponse] -> ShowS #
NFData ImportComponentResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods rnf :: ImportComponentResponse -> () #
Eq ImportComponentResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent Methods (==) :: ImportComponentResponse -> ImportComponentResponse -> Bool # (/=) :: ImportComponentResponse -> ImportComponentResponse -> Bool #
type Rep ImportComponentResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ImportComponent type Rep ImportComponentResponse = D1 ('MetaData "ImportComponentResponse" "Amazonka.ImageBuilder.ImportComponent" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "ImportComponentResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "componentBuildVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newImportComponentResponse Source #

Arguments

:: Int	`$sel:httpStatus:ImportComponentResponse'`
-> ImportComponentResponse

Create a value of ImportComponentResponse 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:

ImportComponent, importComponentResponse_clientToken - The idempotency token used to make this request idempotent.

$sel:componentBuildVersionArn:ImportComponentResponse', importComponentResponse_componentBuildVersionArn - The Amazon Resource Name (ARN) of the imported component.

$sel:requestId:ImportComponentResponse', importComponentResponse_requestId - The request ID that uniquely identifies this request.

$sel:httpStatus:ImportComponentResponse', importComponentResponse_httpStatus - The response's http status code.

Response Lenses

importComponentResponse_clientToken :: Lens' ImportComponentResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

importComponentResponse_componentBuildVersionArn :: Lens' ImportComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the imported component.

importComponentResponse_requestId :: Lens' ImportComponentResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

importComponentResponse_httpStatus :: Lens' ImportComponentResponse Int Source #

The response's http status code.