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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation creates a revision for a data set.

Synopsis

data CreateRevision = CreateRevision' {
- comment :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- dataSetId :: Text
}
newCreateRevision :: Text -> CreateRevision
createRevision_comment :: Lens' CreateRevision (Maybe Text)
createRevision_tags :: Lens' CreateRevision (Maybe (HashMap Text Text))
createRevision_dataSetId :: Lens' CreateRevision Text
data CreateRevisionResponse = CreateRevisionResponse' {
- arn :: Maybe Text
- comment :: Maybe Text
- createdAt :: Maybe ISO8601
- dataSetId :: Maybe Text
- finalized :: Maybe Bool
- id :: Maybe Text
- revocationComment :: Maybe Text
- revoked :: Maybe Bool
- revokedAt :: Maybe ISO8601
- sourceId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- updatedAt :: Maybe ISO8601
- httpStatus :: Int
}
newCreateRevisionResponse :: Int -> CreateRevisionResponse
createRevisionResponse_arn :: Lens' CreateRevisionResponse (Maybe Text)
createRevisionResponse_comment :: Lens' CreateRevisionResponse (Maybe Text)
createRevisionResponse_createdAt :: Lens' CreateRevisionResponse (Maybe UTCTime)
createRevisionResponse_dataSetId :: Lens' CreateRevisionResponse (Maybe Text)
createRevisionResponse_finalized :: Lens' CreateRevisionResponse (Maybe Bool)
createRevisionResponse_id :: Lens' CreateRevisionResponse (Maybe Text)
createRevisionResponse_revocationComment :: Lens' CreateRevisionResponse (Maybe Text)
createRevisionResponse_revoked :: Lens' CreateRevisionResponse (Maybe Bool)
createRevisionResponse_revokedAt :: Lens' CreateRevisionResponse (Maybe UTCTime)
createRevisionResponse_sourceId :: Lens' CreateRevisionResponse (Maybe Text)
createRevisionResponse_tags :: Lens' CreateRevisionResponse (Maybe (HashMap Text Text))
createRevisionResponse_updatedAt :: Lens' CreateRevisionResponse (Maybe UTCTime)
createRevisionResponse_httpStatus :: Lens' CreateRevisionResponse Int

Creating a Request

data CreateRevision Source #

See: newCreateRevision smart constructor.

Constructors

CreateRevision'

Fields

comment :: Maybe Text
An optional comment about the revision.
tags :: Maybe (HashMap Text Text)
A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.
dataSetId :: Text
The unique identifier for a data set.

Instances

Instances details

ToJSON CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods toJSON :: CreateRevision -> Value # toEncoding :: CreateRevision -> Encoding # toJSONList :: [CreateRevision] -> Value # toEncodingList :: [CreateRevision] -> Encoding #
ToHeaders CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods toHeaders :: CreateRevision -> [Header] #
ToPath CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods toPath :: CreateRevision -> ByteString #
ToQuery CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods toQuery :: CreateRevision -> QueryString #
AWSRequest CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Associated Types type AWSResponse CreateRevision # Methods request :: (Service -> Service) -> CreateRevision -> Request CreateRevision # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateRevision -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRevision))) #
Generic CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Associated Types type Rep CreateRevision :: Type -> Type # Methods from :: CreateRevision -> Rep CreateRevision x # to :: Rep CreateRevision x -> CreateRevision #
Read CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods readsPrec :: Int -> ReadS CreateRevision # readList :: ReadS [CreateRevision] # readPrec :: ReadPrec CreateRevision # readListPrec :: ReadPrec [CreateRevision] #
Show CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods showsPrec :: Int -> CreateRevision -> ShowS # show :: CreateRevision -> String # showList :: [CreateRevision] -> ShowS #
NFData CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods rnf :: CreateRevision -> () #
Eq CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods (==) :: CreateRevision -> CreateRevision -> Bool # (/=) :: CreateRevision -> CreateRevision -> Bool #
Hashable CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods hashWithSalt :: Int -> CreateRevision -> Int # hash :: CreateRevision -> Int #
type AWSResponse CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision type AWSResponse CreateRevision = CreateRevisionResponse
type Rep CreateRevision Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision type Rep CreateRevision = D1 ('MetaData "CreateRevision" "Amazonka.DataExchange.CreateRevision" "amazonka-dataexchange-2.0-E9wmOad6xSxAaT3Y4FNlvY" 'False) (C1 ('MetaCons "CreateRevision'" 'PrefixI 'True) (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateRevision Source #

Arguments

:: Text	`CreateRevision`
-> CreateRevision

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

CreateRevision, createRevision_comment - An optional comment about the revision.

CreateRevision, createRevision_tags - A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

CreateRevision, createRevision_dataSetId - The unique identifier for a data set.

Request Lenses

createRevision_comment :: Lens' CreateRevision (Maybe Text) Source #

An optional comment about the revision.

createRevision_tags :: Lens' CreateRevision (Maybe (HashMap Text Text)) Source #

A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

createRevision_dataSetId :: Lens' CreateRevision Text Source #

The unique identifier for a data set.

Destructuring the Response

data CreateRevisionResponse Source #

See: newCreateRevisionResponse smart constructor.

Constructors

CreateRevisionResponse'

Fields

arn :: Maybe Text
The ARN for the revision.
comment :: Maybe Text
An optional comment about the revision.
createdAt :: Maybe ISO8601
The date and time that the revision was created, in ISO 8601 format.
dataSetId :: Maybe Text
The unique identifier for the data set associated with the data set revision.
finalized :: Maybe Bool
To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.
id :: Maybe Text
The unique identifier for the revision.
revocationComment :: Maybe Text
A required comment to inform subscribers of the reason their access to the revision was revoked.
revoked :: Maybe Bool
A status indicating that subscribers' access to the revision was revoked.
revokedAt :: Maybe ISO8601
The date and time that the revision was revoked, in ISO 8601 format.
sourceId :: Maybe Text
The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.
tags :: Maybe (HashMap Text Text)
The tags for the revision.
updatedAt :: Maybe ISO8601
The date and time that the revision was last updated, in ISO 8601 format.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateRevisionResponse Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Associated Types type Rep CreateRevisionResponse :: Type -> Type # Methods from :: CreateRevisionResponse -> Rep CreateRevisionResponse x # to :: Rep CreateRevisionResponse x -> CreateRevisionResponse #
Read CreateRevisionResponse Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods readsPrec :: Int -> ReadS CreateRevisionResponse # readList :: ReadS [CreateRevisionResponse] # readPrec :: ReadPrec CreateRevisionResponse # readListPrec :: ReadPrec [CreateRevisionResponse] #
Show CreateRevisionResponse Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods showsPrec :: Int -> CreateRevisionResponse -> ShowS # show :: CreateRevisionResponse -> String # showList :: [CreateRevisionResponse] -> ShowS #
NFData CreateRevisionResponse Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods rnf :: CreateRevisionResponse -> () #
Eq CreateRevisionResponse Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision Methods (==) :: CreateRevisionResponse -> CreateRevisionResponse -> Bool # (/=) :: CreateRevisionResponse -> CreateRevisionResponse -> Bool #
type Rep CreateRevisionResponse Source #
Instance details Defined in Amazonka.DataExchange.CreateRevision type Rep CreateRevisionResponse = D1 ('MetaData "CreateRevisionResponse" "Amazonka.DataExchange.CreateRevision" "amazonka-dataexchange-2.0-E9wmOad6xSxAaT3Y4FNlvY" 'False) (C1 ('MetaCons "CreateRevisionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: (S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "finalized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "revocationComment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "revoked") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "revokedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: ((S1 ('MetaSel ('Just "sourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateRevisionResponse Source #

Arguments

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

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

CreateRevisionResponse, createRevisionResponse_arn - The ARN for the revision.

CreateRevision, createRevisionResponse_comment - An optional comment about the revision.

CreateRevisionResponse, createRevisionResponse_createdAt - The date and time that the revision was created, in ISO 8601 format.

CreateRevision, createRevisionResponse_dataSetId - The unique identifier for the data set associated with the data set revision.

CreateRevisionResponse, createRevisionResponse_finalized - To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

CreateRevisionResponse, createRevisionResponse_id - The unique identifier for the revision.

CreateRevisionResponse, createRevisionResponse_revocationComment - A required comment to inform subscribers of the reason their access to the revision was revoked.

CreateRevisionResponse, createRevisionResponse_revoked - A status indicating that subscribers' access to the revision was revoked.

CreateRevisionResponse, createRevisionResponse_revokedAt - The date and time that the revision was revoked, in ISO 8601 format.

CreateRevisionResponse, createRevisionResponse_sourceId - The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

CreateRevision, createRevisionResponse_tags - The tags for the revision.

CreateRevisionResponse, createRevisionResponse_updatedAt - The date and time that the revision was last updated, in ISO 8601 format.

$sel:httpStatus:CreateRevisionResponse', createRevisionResponse_httpStatus - The response's http status code.

Response Lenses

createRevisionResponse_arn :: Lens' CreateRevisionResponse (Maybe Text) Source #

The ARN for the revision.

createRevisionResponse_comment :: Lens' CreateRevisionResponse (Maybe Text) Source #

An optional comment about the revision.

createRevisionResponse_createdAt :: Lens' CreateRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was created, in ISO 8601 format.

createRevisionResponse_dataSetId :: Lens' CreateRevisionResponse (Maybe Text) Source #

The unique identifier for the data set associated with the data set revision.

createRevisionResponse_finalized :: Lens' CreateRevisionResponse (Maybe Bool) Source #

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

createRevisionResponse_id :: Lens' CreateRevisionResponse (Maybe Text) Source #

The unique identifier for the revision.

createRevisionResponse_revocationComment :: Lens' CreateRevisionResponse (Maybe Text) Source #

A required comment to inform subscribers of the reason their access to the revision was revoked.

createRevisionResponse_revoked :: Lens' CreateRevisionResponse (Maybe Bool) Source #

A status indicating that subscribers' access to the revision was revoked.

createRevisionResponse_revokedAt :: Lens' CreateRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was revoked, in ISO 8601 format.

createRevisionResponse_sourceId :: Lens' CreateRevisionResponse (Maybe Text) Source #

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

createRevisionResponse_tags :: Lens' CreateRevisionResponse (Maybe (HashMap Text Text)) Source #

The tags for the revision.

createRevisionResponse_updatedAt :: Lens' CreateRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was last updated, in ISO 8601 format.

createRevisionResponse_httpStatus :: Lens' CreateRevisionResponse Int Source #

The response's http status code.