| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Backup.StartReportJob
Description
Starts an on-demand report job for the specified report plan.
Synopsis
- data StartReportJob = StartReportJob' {}
- newStartReportJob :: Text -> StartReportJob
- startReportJob_idempotencyToken :: Lens' StartReportJob (Maybe Text)
- startReportJob_reportPlanName :: Lens' StartReportJob Text
- data StartReportJobResponse = StartReportJobResponse' {
- reportJobId :: Maybe Text
- httpStatus :: Int
- newStartReportJobResponse :: Int -> StartReportJobResponse
- startReportJobResponse_reportJobId :: Lens' StartReportJobResponse (Maybe Text)
- startReportJobResponse_httpStatus :: Lens' StartReportJobResponse Int
Creating a Request
data StartReportJob Source #
See: newStartReportJob smart constructor.
Constructors
| StartReportJob' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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.
$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
| |
Instances
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.
startReportJobResponse_httpStatus :: Lens' StartReportJobResponse Int Source #
The response's http status code.