| 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.Personalize.DescribeCampaign
Description
Describes the given campaign, including its status.
A campaign can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED, the response includes the
failureReason key, which describes why.
For more information on campaigns, see CreateCampaign.
Synopsis
- data DescribeCampaign = DescribeCampaign' {
- campaignArn :: Text
- newDescribeCampaign :: Text -> DescribeCampaign
- describeCampaign_campaignArn :: Lens' DescribeCampaign Text
- data DescribeCampaignResponse = DescribeCampaignResponse' {
- campaign :: Maybe Campaign
- httpStatus :: Int
- newDescribeCampaignResponse :: Int -> DescribeCampaignResponse
- describeCampaignResponse_campaign :: Lens' DescribeCampaignResponse (Maybe Campaign)
- describeCampaignResponse_httpStatus :: Lens' DescribeCampaignResponse Int
Creating a Request
data DescribeCampaign Source #
See: newDescribeCampaign smart constructor.
Constructors
| DescribeCampaign' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribeCampaign |
Create a value of DescribeCampaign 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:campaignArn:DescribeCampaign', describeCampaign_campaignArn - The Amazon Resource Name (ARN) of the campaign.
Request Lenses
describeCampaign_campaignArn :: Lens' DescribeCampaign Text Source #
The Amazon Resource Name (ARN) of the campaign.
Destructuring the Response
data DescribeCampaignResponse Source #
See: newDescribeCampaignResponse smart constructor.
Constructors
| DescribeCampaignResponse' | |
Fields
| |
Instances
newDescribeCampaignResponse Source #
Create a value of DescribeCampaignResponse 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:campaign:DescribeCampaignResponse', describeCampaignResponse_campaign - The properties of the campaign.
$sel:httpStatus:DescribeCampaignResponse', describeCampaignResponse_httpStatus - The response's http status code.
Response Lenses
describeCampaignResponse_campaign :: Lens' DescribeCampaignResponse (Maybe Campaign) Source #
The properties of the campaign.
describeCampaignResponse_httpStatus :: Lens' DescribeCampaignResponse Int Source #
The response's http status code.