amazonka-dataexchange-2.0: Amazon Data Exchange 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.DataExchange.UpdateRevision

Description

This operation updates a revision.

Synopsis

Creating a Request

data UpdateRevision Source #

See: newUpdateRevision smart constructor.

Constructors

UpdateRevision' 

Fields

  • comment :: Maybe Text

    An optional comment about the revision.

  • finalized :: Maybe Bool

    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.

  • dataSetId :: Text

    The unique identifier for a data set.

  • revisionId :: Text

    The unique identifier for a revision.

Instances

Instances details
ToJSON UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

ToHeaders UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

ToPath UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

ToQuery UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

AWSRequest UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

Associated Types

type AWSResponse UpdateRevision #

Generic UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

Associated Types

type Rep UpdateRevision :: Type -> Type #

Read UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

Show UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

NFData UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

Methods

rnf :: UpdateRevision -> () #

Eq UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

Hashable UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

type AWSResponse UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

type Rep UpdateRevision Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

type Rep UpdateRevision = D1 ('MetaData "UpdateRevision" "Amazonka.DataExchange.UpdateRevision" "amazonka-dataexchange-2.0-E9wmOad6xSxAaT3Y4FNlvY" 'False) (C1 ('MetaCons "UpdateRevision'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "finalized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateRevision Source #

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

UpdateRevision, updateRevision_comment - An optional comment about the revision.

UpdateRevision, updateRevision_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.

UpdateRevision, updateRevision_dataSetId - The unique identifier for a data set.

UpdateRevision, updateRevision_revisionId - The unique identifier for a revision.

Request Lenses

updateRevision_comment :: Lens' UpdateRevision (Maybe Text) Source #

An optional comment about the revision.

updateRevision_finalized :: Lens' UpdateRevision (Maybe Bool) Source #

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.

updateRevision_dataSetId :: Lens' UpdateRevision Text Source #

The unique identifier for a data set.

updateRevision_revisionId :: Lens' UpdateRevision Text Source #

The unique identifier for a revision.

Destructuring the Response

data UpdateRevisionResponse Source #

See: newUpdateRevisionResponse smart constructor.

Constructors

UpdateRevisionResponse' 

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

  • 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 UpdateRevisionResponse Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

Associated Types

type Rep UpdateRevisionResponse :: Type -> Type #

Read UpdateRevisionResponse Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

Show UpdateRevisionResponse Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

NFData UpdateRevisionResponse Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

Methods

rnf :: UpdateRevisionResponse -> () #

Eq UpdateRevisionResponse Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

type Rep UpdateRevisionResponse Source # 
Instance details

Defined in Amazonka.DataExchange.UpdateRevision

type Rep UpdateRevisionResponse = D1 ('MetaData "UpdateRevisionResponse" "Amazonka.DataExchange.UpdateRevision" "amazonka-dataexchange-2.0-E9wmOad6xSxAaT3Y4FNlvY" 'False) (C1 ('MetaCons "UpdateRevisionResponse'" '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 "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateRevisionResponse Source #

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

UpdateRevisionResponse, updateRevisionResponse_arn - The ARN for the revision.

UpdateRevision, updateRevisionResponse_comment - An optional comment about the revision.

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

UpdateRevision, updateRevisionResponse_dataSetId - The unique identifier for the data set associated with the data set revision.

UpdateRevision, updateRevisionResponse_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 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.

UpdateRevisionResponse, updateRevisionResponse_id - The unique identifier for the revision.

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

UpdateRevisionResponse, updateRevisionResponse_revoked - A status indicating that subscribers' access to the revision was revoked.

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

UpdateRevisionResponse, updateRevisionResponse_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.

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

$sel:httpStatus:UpdateRevisionResponse', updateRevisionResponse_httpStatus - The response's http status code.

Response Lenses

updateRevisionResponse_comment :: Lens' UpdateRevisionResponse (Maybe Text) Source #

An optional comment about the revision.

updateRevisionResponse_createdAt :: Lens' UpdateRevisionResponse (Maybe UTCTime) Source #

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

updateRevisionResponse_dataSetId :: Lens' UpdateRevisionResponse (Maybe Text) Source #

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

updateRevisionResponse_finalized :: Lens' UpdateRevisionResponse (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 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.

updateRevisionResponse_id :: Lens' UpdateRevisionResponse (Maybe Text) Source #

The unique identifier for the revision.

updateRevisionResponse_revocationComment :: Lens' UpdateRevisionResponse (Maybe Text) Source #

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

updateRevisionResponse_revoked :: Lens' UpdateRevisionResponse (Maybe Bool) Source #

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

updateRevisionResponse_revokedAt :: Lens' UpdateRevisionResponse (Maybe UTCTime) Source #

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

updateRevisionResponse_sourceId :: Lens' UpdateRevisionResponse (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.

updateRevisionResponse_updatedAt :: Lens' UpdateRevisionResponse (Maybe UTCTime) Source #

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