libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.CancelExportTask

Description

Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.

Synopsis

Creating a Request

data CancelExportTask Source #

See: newCancelExportTask smart constructor.

Constructors

CancelExportTask' 

Fields

Instances

Instances details
Eq CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Methods

(==) :: CancelExportTask -> CancelExportTask -> Bool #

(/=) :: CancelExportTask -> CancelExportTask -> Bool #

Read CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Methods

readsPrec :: Int -> ReadS CancelExportTask #

readList :: ReadS [CancelExportTask] #

readPrec :: ReadPrec CancelExportTask #

readListPrec :: ReadPrec [CancelExportTask] #

Show CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Methods

showsPrec :: Int -> CancelExportTask -> ShowS #

show :: CancelExportTask -> String #

showList :: [CancelExportTask] -> ShowS #

Generic CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Associated Types

type Rep CancelExportTask :: Type -> Type #

Methods

from :: CancelExportTask -> Rep CancelExportTask x #

to :: Rep CancelExportTask x -> CancelExportTask #

NFData CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Methods

rnf :: CancelExportTask -> () #

Hashable CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Methods

hashWithSalt :: Int -> CancelExportTask -> Int #

hash :: CancelExportTask -> Int #

AWSRequest CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Associated Types

type AWSResponse CancelExportTask #

Methods

request :: CancelExportTask -> Request CancelExportTask #

response :: MonadResource m => Logger -> Service -> Proxy CancelExportTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelExportTask))) #

ToHeaders CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Methods

toHeaders :: CancelExportTask -> [Header] #

ToPath CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Methods

toPath :: CancelExportTask -> ByteString #

ToQuery CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

Methods

toQuery :: CancelExportTask -> QueryString #

type Rep CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

type Rep CancelExportTask = D1 ('MetaData "CancelExportTask" "Amazonka.RDS.CancelExportTask" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CancelExportTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exportTaskIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CancelExportTask Source # 
Instance details

Defined in Amazonka.RDS.CancelExportTask

type AWSResponse CancelExportTask = ExportTask

newCancelExportTask Source #

Arguments

:: Text

$sel:exportTaskIdentifier:CancelExportTask'

-> CancelExportTask 

Create a value of CancelExportTask 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:exportTaskIdentifier:CancelExportTask', cancelExportTask_exportTaskIdentifier - The identifier of the snapshot export task to cancel.

Request Lenses

cancelExportTask_exportTaskIdentifier :: Lens' CancelExportTask Text Source #

The identifier of the snapshot export task to cancel.

Destructuring the Response

data ExportTask Source #

Contains the details of a snapshot export to Amazon S3.

This data type is used as a response element in the DescribeExportTasks action.

See: newExportTask smart constructor.

Constructors

ExportTask' 

Fields

  • totalExtractedDataInGB :: Maybe Int

    The total amount of data exported, in gigabytes.

  • status :: Maybe Text

    The progress status of the export task.

  • iamRoleArn :: Maybe Text

    The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

  • sourceArn :: Maybe Text

    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

  • exportOnly :: Maybe [Text]

    The data exported from the snapshot. Valid values are the following:

    • database - Export all the data from a specified database.
    • database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
    • database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
    • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
  • taskStartTime :: Maybe ISO8601

    The time that the snapshot export task started.

  • warningMessage :: Maybe Text

    A warning about the snapshot export task.

  • snapshotTime :: Maybe ISO8601

    The time that the snapshot was created.

  • kmsKeyId :: Maybe Text

    The key identifier of the Amazon Web Services KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The Amazon Web Services KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this Amazon Web Services KMS CMK.

  • taskEndTime :: Maybe ISO8601

    The time that the snapshot export task completed.

  • exportTaskIdentifier :: Maybe Text

    A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

  • s3Prefix :: Maybe Text

    The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

  • percentProgress :: Maybe Int

    The progress of the snapshot export task as a percentage.

  • s3Bucket :: Maybe Text

    The Amazon S3 bucket that the snapshot is exported to.

  • failureCause :: Maybe Text

    The reason the export failed, if it failed.

Instances

Instances details
Eq ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Methods

(==) :: ExportTask -> ExportTask -> Bool #

(/=) :: ExportTask -> ExportTask -> Bool #

Read ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Methods

readsPrec :: Int -> ReadS ExportTask #

readList :: ReadS [ExportTask] #

readPrec :: ReadPrec ExportTask #

readListPrec :: ReadPrec [ExportTask] #

Show ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Methods

showsPrec :: Int -> ExportTask -> ShowS #

show :: ExportTask -> String #

showList :: [ExportTask] -> ShowS #

Generic ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Associated Types

type Rep ExportTask :: Type -> Type #

Methods

from :: ExportTask -> Rep ExportTask x #

to :: Rep ExportTask x -> ExportTask #

NFData ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Methods

rnf :: ExportTask -> () #

Hashable ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Methods

hashWithSalt :: Int -> ExportTask -> Int #

hash :: ExportTask -> Int #

FromXML ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Methods

parseXML :: [Node] -> Either String ExportTask #

type Rep ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

type Rep ExportTask = D1 ('MetaData "ExportTask" "Amazonka.RDS.Types.ExportTask" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ExportTask'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "totalExtractedDataInGB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "exportOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "taskStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "warningMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "snapshotTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "taskEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "exportTaskIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureCause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newExportTask :: ExportTask Source #

Create a value of ExportTask 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:totalExtractedDataInGB:ExportTask', exportTask_totalExtractedDataInGB - The total amount of data exported, in gigabytes.

$sel:status:ExportTask', exportTask_status - The progress status of the export task.

$sel:iamRoleArn:ExportTask', exportTask_iamRoleArn - The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

$sel:sourceArn:ExportTask', exportTask_sourceArn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

$sel:exportOnly:ExportTask', exportTask_exportOnly - The data exported from the snapshot. Valid values are the following:

  • database - Export all the data from a specified database.
  • database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
  • database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
  • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

$sel:taskStartTime:ExportTask', exportTask_taskStartTime - The time that the snapshot export task started.

$sel:warningMessage:ExportTask', exportTask_warningMessage - A warning about the snapshot export task.

$sel:snapshotTime:ExportTask', exportTask_snapshotTime - The time that the snapshot was created.

$sel:kmsKeyId:ExportTask', exportTask_kmsKeyId - The key identifier of the Amazon Web Services KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The Amazon Web Services KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this Amazon Web Services KMS CMK.

$sel:taskEndTime:ExportTask', exportTask_taskEndTime - The time that the snapshot export task completed.

$sel:exportTaskIdentifier:ExportTask', exportTask_exportTaskIdentifier - A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

$sel:s3Prefix:ExportTask', exportTask_s3Prefix - The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

$sel:percentProgress:ExportTask', exportTask_percentProgress - The progress of the snapshot export task as a percentage.

$sel:s3Bucket:ExportTask', exportTask_s3Bucket - The Amazon S3 bucket that the snapshot is exported to.

$sel:failureCause:ExportTask', exportTask_failureCause - The reason the export failed, if it failed.

Response Lenses

exportTask_totalExtractedDataInGB :: Lens' ExportTask (Maybe Int) Source #

The total amount of data exported, in gigabytes.

exportTask_status :: Lens' ExportTask (Maybe Text) Source #

The progress status of the export task.

exportTask_iamRoleArn :: Lens' ExportTask (Maybe Text) Source #

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

exportTask_sourceArn :: Lens' ExportTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

exportTask_exportOnly :: Lens' ExportTask (Maybe [Text]) Source #

The data exported from the snapshot. Valid values are the following:

  • database - Export all the data from a specified database.
  • database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
  • database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
  • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

exportTask_taskStartTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task started.

exportTask_warningMessage :: Lens' ExportTask (Maybe Text) Source #

A warning about the snapshot export task.

exportTask_snapshotTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot was created.

exportTask_kmsKeyId :: Lens' ExportTask (Maybe Text) Source #

The key identifier of the Amazon Web Services KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The Amazon Web Services KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this Amazon Web Services KMS CMK.

exportTask_taskEndTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task completed.

exportTask_exportTaskIdentifier :: Lens' ExportTask (Maybe Text) Source #

A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

exportTask_s3Prefix :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

exportTask_percentProgress :: Lens' ExportTask (Maybe Int) Source #

The progress of the snapshot export task as a percentage.

exportTask_s3Bucket :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket that the snapshot is exported to.

exportTask_failureCause :: Lens' ExportTask (Maybe Text) Source #

The reason the export failed, if it failed.