Amazonka.Backup.StartReportJob

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

Creating a Request

data StartReportJob

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

ToJSON StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

toJSON :: StartReportJob -> Value

toEncoding :: StartReportJob -> Encoding

toJSONList :: [StartReportJob] -> Value

toEncodingList :: [StartReportJob] -> Encoding

ToHeaders StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

toHeaders :: StartReportJob -> [Header]

ToPath StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

toPath :: StartReportJob -> ByteString

ToQuery StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

toQuery :: StartReportJob -> QueryString

AWSRequest StartReportJob

Defined in Amazonka.Backup.StartReportJob

Associated Types

type AWSResponse StartReportJob

Methods

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

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

Generic StartReportJob

Defined in Amazonka.Backup.StartReportJob

Associated Types

type Rep StartReportJob :: Type -> Type

Methods

from :: StartReportJob -> Rep StartReportJob x

to :: Rep StartReportJob x -> StartReportJob

Read StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

readsPrec :: Int -> ReadS StartReportJob

readList :: ReadS [StartReportJob]

readPrec :: ReadPrec StartReportJob

readListPrec :: ReadPrec [StartReportJob]

Show StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

showsPrec :: Int -> StartReportJob -> ShowS

show :: StartReportJob -> String

showList :: [StartReportJob] -> ShowS

NFData StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

rnf :: StartReportJob -> ()

Eq StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

(==) :: StartReportJob -> StartReportJob -> Bool

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

Hashable StartReportJob

Defined in Amazonka.Backup.StartReportJob

Methods

hashWithSalt :: Int -> StartReportJob -> Int

hash :: StartReportJob -> Int

type AWSResponse StartReportJob

Defined in Amazonka.Backup.StartReportJob

type AWSResponse StartReportJob = StartReportJobResponse

type Rep StartReportJob

Defined in Amazonka.Backup.StartReportJob

type Rep StartReportJob = D1 ('MetaData "StartReportJob" "Amazonka.Backup.StartReportJob" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" '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)))

newStartReportJob

Arguments

:: Text

StartReportJob

-> StartReportJob

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.

StartReportJob, startReportJob_reportPlanName - The unique name of a report plan.

Request Lenses

startReportJob_idempotencyToken :: Lens' StartReportJob (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.

startReportJob_reportPlanName :: Lens' StartReportJob Text

The unique name of a report plan.

Destructuring the Response

data StartReportJobResponse

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

Generic StartReportJobResponse

Defined in Amazonka.Backup.StartReportJob

Associated Types

type Rep StartReportJobResponse :: Type -> Type

Methods

from :: StartReportJobResponse -> Rep StartReportJobResponse x

to :: Rep StartReportJobResponse x -> StartReportJobResponse

Read StartReportJobResponse

Defined in Amazonka.Backup.StartReportJob

Methods

readsPrec :: Int -> ReadS StartReportJobResponse

readList :: ReadS [StartReportJobResponse]

readPrec :: ReadPrec StartReportJobResponse

readListPrec :: ReadPrec [StartReportJobResponse]

Show StartReportJobResponse

Defined in Amazonka.Backup.StartReportJob

Methods

showsPrec :: Int -> StartReportJobResponse -> ShowS

show :: StartReportJobResponse -> String

showList :: [StartReportJobResponse] -> ShowS

NFData StartReportJobResponse

Defined in Amazonka.Backup.StartReportJob

Methods

rnf :: StartReportJobResponse -> ()

Eq StartReportJobResponse

Defined in Amazonka.Backup.StartReportJob

Methods

(==) :: StartReportJobResponse -> StartReportJobResponse -> Bool

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

type Rep StartReportJobResponse

Defined in Amazonka.Backup.StartReportJob

type Rep StartReportJobResponse = D1 ('MetaData "StartReportJobResponse" "Amazonka.Backup.StartReportJob" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" '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

Arguments

:: Int

$sel:httpStatus:StartReportJobResponse'

-> StartReportJobResponse

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:

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)

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.

startReportJobResponse_httpStatus :: Lens' StartReportJobResponse Int

The response's http status code.