libZSservicesZSamazonka-backupZSamazonka-backup
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.Backup.StartReportJob

Description

Starts an on-demand report job for the specified report plan.

Synopsis

Creating a Request

data StartReportJob Source #

See: newStartReportJob smart constructor.

Constructors

StartReportJob' 

Fields

  • idempotencyToken :: Maybe Text

    A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

  • reportPlanName :: Text

    The unique name of a report plan.

Instances

Instances details
Eq StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Read StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Show StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Generic StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Associated Types

type Rep StartReportJob :: Type -> Type #

NFData StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Methods

rnf :: StartReportJob -> () #

Hashable StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

ToJSON StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

AWSRequest StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Associated Types

type AWSResponse StartReportJob #

ToHeaders StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

ToPath StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

ToQuery StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

type Rep StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

type Rep StartReportJob = D1 ('MetaData "StartReportJob" "Amazonka.Backup.StartReportJob" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "StartReportJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reportPlanName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StartReportJob Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

newStartReportJob Source #

Create a value of StartReportJob 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:idempotencyToken:StartReportJob', startReportJob_idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

$sel:reportPlanName:StartReportJob', startReportJob_reportPlanName - The unique name of a report plan.

Request Lenses

startReportJob_idempotencyToken :: Lens' StartReportJob (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

startReportJob_reportPlanName :: Lens' StartReportJob Text Source #

The unique name of a report plan.

Destructuring the Response

data StartReportJobResponse Source #

See: newStartReportJobResponse smart constructor.

Constructors

StartReportJobResponse' 

Fields

  • reportJobId :: Maybe Text

    The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq StartReportJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Read StartReportJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Show StartReportJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Generic StartReportJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Associated Types

type Rep StartReportJobResponse :: Type -> Type #

NFData StartReportJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

Methods

rnf :: StartReportJobResponse -> () #

type Rep StartReportJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartReportJob

type Rep StartReportJobResponse = D1 ('MetaData "StartReportJobResponse" "Amazonka.Backup.StartReportJob" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "StartReportJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reportJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartReportJobResponse Source #

Create a value of StartReportJobResponse 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:reportJobId:StartReportJobResponse', startReportJobResponse_reportJobId - The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

$sel:httpStatus:StartReportJobResponse', startReportJobResponse_httpStatus - The response's http status code.

Response Lenses

startReportJobResponse_reportJobId :: Lens' StartReportJobResponse (Maybe Text) Source #

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.