Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AlexaBusiness.CreateBusinessReportSchedule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

Synopsis

Creating a Request

data CreateBusinessReportSchedule Source #

See: newCreateBusinessReportSchedule smart constructor.

Constructors

CreateBusinessReportSchedule'

Fields

clientRequestToken :: Maybe Text
The client request token.
recurrence :: Maybe BusinessReportRecurrence
The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
s3BucketName :: Maybe Text
The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.
s3KeyPrefix :: Maybe Text
The S3 key where the report is delivered.
scheduleName :: Maybe Text
The name identifier of the schedule.
tags :: Maybe [Tag]
The tags for the business report schedule.
format :: BusinessReportFormat
The format of the generated report (individual CSV files or zipped files of individual files).
contentRange :: BusinessReportContentRange
The content range of the reports.

Instances

Instances details

ToJSON CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods toJSON :: CreateBusinessReportSchedule -> Value # toEncoding :: CreateBusinessReportSchedule -> Encoding # toJSONList :: [CreateBusinessReportSchedule] -> Value # toEncodingList :: [CreateBusinessReportSchedule] -> Encoding #
ToHeaders CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods toHeaders :: CreateBusinessReportSchedule -> [Header] #
ToPath CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods toPath :: CreateBusinessReportSchedule -> ByteString #
ToQuery CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods toQuery :: CreateBusinessReportSchedule -> QueryString #
AWSRequest CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Associated Types type AWSResponse CreateBusinessReportSchedule # Methods request :: (Service -> Service) -> CreateBusinessReportSchedule -> Request CreateBusinessReportSchedule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBusinessReportSchedule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBusinessReportSchedule))) #
Generic CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Associated Types type Rep CreateBusinessReportSchedule :: Type -> Type # Methods from :: CreateBusinessReportSchedule -> Rep CreateBusinessReportSchedule x # to :: Rep CreateBusinessReportSchedule x -> CreateBusinessReportSchedule #
Read CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods readsPrec :: Int -> ReadS CreateBusinessReportSchedule # readList :: ReadS [CreateBusinessReportSchedule] # readPrec :: ReadPrec CreateBusinessReportSchedule # readListPrec :: ReadPrec [CreateBusinessReportSchedule] #
Show CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods showsPrec :: Int -> CreateBusinessReportSchedule -> ShowS # show :: CreateBusinessReportSchedule -> String # showList :: [CreateBusinessReportSchedule] -> ShowS #
NFData CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods rnf :: CreateBusinessReportSchedule -> () #
Eq CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods (==) :: CreateBusinessReportSchedule -> CreateBusinessReportSchedule -> Bool # (/=) :: CreateBusinessReportSchedule -> CreateBusinessReportSchedule -> Bool #
Hashable CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods hashWithSalt :: Int -> CreateBusinessReportSchedule -> Int # hash :: CreateBusinessReportSchedule -> Int #
type AWSResponse CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule type AWSResponse CreateBusinessReportSchedule = CreateBusinessReportScheduleResponse
type Rep CreateBusinessReportSchedule Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule type Rep CreateBusinessReportSchedule = D1 ('MetaData "CreateBusinessReportSchedule" "Amazonka.AlexaBusiness.CreateBusinessReportSchedule" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "CreateBusinessReportSchedule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recurrence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BusinessReportRecurrence))) :: (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "scheduleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BusinessReportFormat) :*: S1 ('MetaSel ('Just "contentRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BusinessReportContentRange)))))

newCreateBusinessReportSchedule Source #

Arguments

:: BusinessReportFormat	`CreateBusinessReportSchedule`
-> BusinessReportContentRange	`CreateBusinessReportSchedule`
-> CreateBusinessReportSchedule

Create a value of CreateBusinessReportSchedule 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:clientRequestToken:CreateBusinessReportSchedule', createBusinessReportSchedule_clientRequestToken - The client request token.

CreateBusinessReportSchedule, createBusinessReportSchedule_recurrence - The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

CreateBusinessReportSchedule, createBusinessReportSchedule_s3BucketName - The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

CreateBusinessReportSchedule, createBusinessReportSchedule_s3KeyPrefix - The S3 key where the report is delivered.

CreateBusinessReportSchedule, createBusinessReportSchedule_scheduleName - The name identifier of the schedule.

$sel:tags:CreateBusinessReportSchedule', createBusinessReportSchedule_tags - The tags for the business report schedule.

CreateBusinessReportSchedule, createBusinessReportSchedule_format - The format of the generated report (individual CSV files or zipped files of individual files).

CreateBusinessReportSchedule, createBusinessReportSchedule_contentRange - The content range of the reports.

Request Lenses

createBusinessReportSchedule_clientRequestToken :: Lens' CreateBusinessReportSchedule (Maybe Text) Source #

The client request token.

createBusinessReportSchedule_recurrence :: Lens' CreateBusinessReportSchedule (Maybe BusinessReportRecurrence) Source #

The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

createBusinessReportSchedule_s3BucketName :: Lens' CreateBusinessReportSchedule (Maybe Text) Source #

The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

createBusinessReportSchedule_s3KeyPrefix :: Lens' CreateBusinessReportSchedule (Maybe Text) Source #

The S3 key where the report is delivered.

createBusinessReportSchedule_scheduleName :: Lens' CreateBusinessReportSchedule (Maybe Text) Source #

The name identifier of the schedule.

createBusinessReportSchedule_tags :: Lens' CreateBusinessReportSchedule (Maybe [Tag]) Source #

The tags for the business report schedule.

createBusinessReportSchedule_format :: Lens' CreateBusinessReportSchedule BusinessReportFormat Source #

The format of the generated report (individual CSV files or zipped files of individual files).

createBusinessReportSchedule_contentRange :: Lens' CreateBusinessReportSchedule BusinessReportContentRange Source #

The content range of the reports.

Destructuring the Response

data CreateBusinessReportScheduleResponse Source #

See: newCreateBusinessReportScheduleResponse smart constructor.

Constructors

CreateBusinessReportScheduleResponse'
Fields scheduleArn :: Maybe Text The ARN of the business report schedule. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateBusinessReportScheduleResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Associated Types type Rep CreateBusinessReportScheduleResponse :: Type -> Type # Methods from :: CreateBusinessReportScheduleResponse -> Rep CreateBusinessReportScheduleResponse x # to :: Rep CreateBusinessReportScheduleResponse x -> CreateBusinessReportScheduleResponse #
Read CreateBusinessReportScheduleResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods readsPrec :: Int -> ReadS CreateBusinessReportScheduleResponse # readList :: ReadS [CreateBusinessReportScheduleResponse] # readPrec :: ReadPrec CreateBusinessReportScheduleResponse # readListPrec :: ReadPrec [CreateBusinessReportScheduleResponse] #
Show CreateBusinessReportScheduleResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods showsPrec :: Int -> CreateBusinessReportScheduleResponse -> ShowS # show :: CreateBusinessReportScheduleResponse -> String # showList :: [CreateBusinessReportScheduleResponse] -> ShowS #
NFData CreateBusinessReportScheduleResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods rnf :: CreateBusinessReportScheduleResponse -> () #
Eq CreateBusinessReportScheduleResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule Methods (==) :: CreateBusinessReportScheduleResponse -> CreateBusinessReportScheduleResponse -> Bool # (/=) :: CreateBusinessReportScheduleResponse -> CreateBusinessReportScheduleResponse -> Bool #
type Rep CreateBusinessReportScheduleResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.CreateBusinessReportSchedule type Rep CreateBusinessReportScheduleResponse = D1 ('MetaData "CreateBusinessReportScheduleResponse" "Amazonka.AlexaBusiness.CreateBusinessReportSchedule" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "CreateBusinessReportScheduleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheduleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateBusinessReportScheduleResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateBusinessReportScheduleResponse'`
-> CreateBusinessReportScheduleResponse

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

CreateBusinessReportScheduleResponse, createBusinessReportScheduleResponse_scheduleArn - The ARN of the business report schedule.

$sel:httpStatus:CreateBusinessReportScheduleResponse', createBusinessReportScheduleResponse_httpStatus - The response's http status code.

Response Lenses

createBusinessReportScheduleResponse_scheduleArn :: Lens' CreateBusinessReportScheduleResponse (Maybe Text) Source #

The ARN of the business report schedule.

createBusinessReportScheduleResponse_httpStatus :: Lens' CreateBusinessReportScheduleResponse Int Source #

The response's http status code.