Amazonka.LakeFormation.DeleteObjectsOnCancel

For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.

The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes.

Creating a Request

data DeleteObjectsOnCancel

See: newDeleteObjectsOnCancel smart constructor.

Constructors

DeleteObjectsOnCancel'

Fields

• catalogId :: Maybe Text

  The Glue data catalog that contains the governed table. Defaults to the current account ID.

• databaseName :: Text

  The database that contains the governed table.

• tableName :: Text

  The name of the governed table.

• transactionId :: Text

  ID of the transaction that the writes occur in.

• objects :: NonEmpty VirtualObject

  A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.

Instances

ToJSON DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

toJSON :: DeleteObjectsOnCancel -> Value

toEncoding :: DeleteObjectsOnCancel -> Encoding

toJSONList :: [DeleteObjectsOnCancel] -> Value

toEncodingList :: [DeleteObjectsOnCancel] -> Encoding

ToHeaders DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

toHeaders :: DeleteObjectsOnCancel -> [Header]

ToPath DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

toPath :: DeleteObjectsOnCancel -> ByteString

ToQuery DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

toQuery :: DeleteObjectsOnCancel -> QueryString

AWSRequest DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Associated Types

type AWSResponse DeleteObjectsOnCancel

Methods

request :: (Service -> Service) -> DeleteObjectsOnCancel -> Request DeleteObjectsOnCancel

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteObjectsOnCancel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteObjectsOnCancel)))

Generic DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Associated Types

type Rep DeleteObjectsOnCancel :: Type -> Type

Methods

from :: DeleteObjectsOnCancel -> Rep DeleteObjectsOnCancel x

to :: Rep DeleteObjectsOnCancel x -> DeleteObjectsOnCancel

Read DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

readsPrec :: Int -> ReadS DeleteObjectsOnCancel

readList :: ReadS [DeleteObjectsOnCancel]

readPrec :: ReadPrec DeleteObjectsOnCancel

readListPrec :: ReadPrec [DeleteObjectsOnCancel]

Show DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

showsPrec :: Int -> DeleteObjectsOnCancel -> ShowS

show :: DeleteObjectsOnCancel -> String

showList :: [DeleteObjectsOnCancel] -> ShowS

NFData DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

rnf :: DeleteObjectsOnCancel -> ()

Eq DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

(==) :: DeleteObjectsOnCancel -> DeleteObjectsOnCancel -> Bool

(/=) :: DeleteObjectsOnCancel -> DeleteObjectsOnCancel -> Bool

Hashable DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

hashWithSalt :: Int -> DeleteObjectsOnCancel -> Int

hash :: DeleteObjectsOnCancel -> Int

type AWSResponse DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

type AWSResponse DeleteObjectsOnCancel = DeleteObjectsOnCancelResponse

type Rep DeleteObjectsOnCancel

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

type Rep DeleteObjectsOnCancel = D1 ('MetaData "DeleteObjectsOnCancel" "Amazonka.LakeFormation.DeleteObjectsOnCancel" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "DeleteObjectsOnCancel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "transactionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "objects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty VirtualObject))))))

newDeleteObjectsOnCancel

Arguments

:: Text

DeleteObjectsOnCancel

-> Text

DeleteObjectsOnCancel

-> Text

DeleteObjectsOnCancel

-> NonEmpty VirtualObject

DeleteObjectsOnCancel

-> DeleteObjectsOnCancel

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

DeleteObjectsOnCancel, deleteObjectsOnCancel_catalogId - The Glue data catalog that contains the governed table. Defaults to the current account ID.

DeleteObjectsOnCancel, deleteObjectsOnCancel_databaseName - The database that contains the governed table.

DeleteObjectsOnCancel, deleteObjectsOnCancel_tableName - The name of the governed table.

DeleteObjectsOnCancel, deleteObjectsOnCancel_transactionId - ID of the transaction that the writes occur in.

DeleteObjectsOnCancel, deleteObjectsOnCancel_objects - A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.

Request Lenses

deleteObjectsOnCancel_catalogId :: Lens' DeleteObjectsOnCancel (Maybe Text)

The Glue data catalog that contains the governed table. Defaults to the current account ID.

deleteObjectsOnCancel_databaseName :: Lens' DeleteObjectsOnCancel Text

The database that contains the governed table.

deleteObjectsOnCancel_tableName :: Lens' DeleteObjectsOnCancel Text

The name of the governed table.

deleteObjectsOnCancel_transactionId :: Lens' DeleteObjectsOnCancel Text

ID of the transaction that the writes occur in.

deleteObjectsOnCancel_objects :: Lens' DeleteObjectsOnCancel (NonEmpty VirtualObject)

A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.

Destructuring the Response

data DeleteObjectsOnCancelResponse

See: newDeleteObjectsOnCancelResponse smart constructor.

Constructors

DeleteObjectsOnCancelResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteObjectsOnCancelResponse

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Associated Types

type Rep DeleteObjectsOnCancelResponse :: Type -> Type

Methods

from :: DeleteObjectsOnCancelResponse -> Rep DeleteObjectsOnCancelResponse x

to :: Rep DeleteObjectsOnCancelResponse x -> DeleteObjectsOnCancelResponse

Read DeleteObjectsOnCancelResponse

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

readsPrec :: Int -> ReadS DeleteObjectsOnCancelResponse

readList :: ReadS [DeleteObjectsOnCancelResponse]

readPrec :: ReadPrec DeleteObjectsOnCancelResponse

readListPrec :: ReadPrec [DeleteObjectsOnCancelResponse]

Show DeleteObjectsOnCancelResponse

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

showsPrec :: Int -> DeleteObjectsOnCancelResponse -> ShowS

show :: DeleteObjectsOnCancelResponse -> String

showList :: [DeleteObjectsOnCancelResponse] -> ShowS

NFData DeleteObjectsOnCancelResponse

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

rnf :: DeleteObjectsOnCancelResponse -> ()

Eq DeleteObjectsOnCancelResponse

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

Methods

(==) :: DeleteObjectsOnCancelResponse -> DeleteObjectsOnCancelResponse -> Bool

(/=) :: DeleteObjectsOnCancelResponse -> DeleteObjectsOnCancelResponse -> Bool

type Rep DeleteObjectsOnCancelResponse

Defined in Amazonka.LakeFormation.DeleteObjectsOnCancel

type Rep DeleteObjectsOnCancelResponse = D1 ('MetaData "DeleteObjectsOnCancelResponse" "Amazonka.LakeFormation.DeleteObjectsOnCancel" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "DeleteObjectsOnCancelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteObjectsOnCancelResponse

Arguments

:: Int

$sel:httpStatus:DeleteObjectsOnCancelResponse'

-> DeleteObjectsOnCancelResponse

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

$sel:httpStatus:DeleteObjectsOnCancelResponse', deleteObjectsOnCancelResponse_httpStatus - The response's http status code.

Response Lenses

deleteObjectsOnCancelResponse_httpStatus :: Lens' DeleteObjectsOnCancelResponse Int

The response's http status code.