Amazonka.Personalize.DescribeCampaign

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.

Creating a Request

data DescribeCampaign

See: newDescribeCampaign smart constructor.

Constructors

DescribeCampaign'

Fields

• campaignArn :: Text

  The Amazon Resource Name (ARN) of the campaign.

Instances

ToJSON DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

toJSON :: DescribeCampaign -> Value

toEncoding :: DescribeCampaign -> Encoding

toJSONList :: [DescribeCampaign] -> Value

toEncodingList :: [DescribeCampaign] -> Encoding

ToHeaders DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

toHeaders :: DescribeCampaign -> [Header]

ToPath DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

toPath :: DescribeCampaign -> ByteString

ToQuery DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

toQuery :: DescribeCampaign -> QueryString

AWSRequest DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Associated Types

type AWSResponse DescribeCampaign

Methods

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

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

Generic DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Associated Types

type Rep DescribeCampaign :: Type -> Type

Methods

from :: DescribeCampaign -> Rep DescribeCampaign x

to :: Rep DescribeCampaign x -> DescribeCampaign

Read DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

readsPrec :: Int -> ReadS DescribeCampaign

readList :: ReadS [DescribeCampaign]

readPrec :: ReadPrec DescribeCampaign

readListPrec :: ReadPrec [DescribeCampaign]

Show DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

showsPrec :: Int -> DescribeCampaign -> ShowS

show :: DescribeCampaign -> String

showList :: [DescribeCampaign] -> ShowS

NFData DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

rnf :: DescribeCampaign -> ()

Eq DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

(==) :: DescribeCampaign -> DescribeCampaign -> Bool

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

Hashable DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

Methods

hashWithSalt :: Int -> DescribeCampaign -> Int

hash :: DescribeCampaign -> Int

type AWSResponse DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

type AWSResponse DescribeCampaign = DescribeCampaignResponse

type Rep DescribeCampaign

Defined in Amazonka.Personalize.DescribeCampaign

type Rep DescribeCampaign = D1 ('MetaData "DescribeCampaign" "Amazonka.Personalize.DescribeCampaign" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "DescribeCampaign'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaignArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeCampaign

Arguments

:: Text

DescribeCampaign

-> 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:

DescribeCampaign, describeCampaign_campaignArn - The Amazon Resource Name (ARN) of the campaign.

Request Lenses

describeCampaign_campaignArn :: Lens' DescribeCampaign Text

The Amazon Resource Name (ARN) of the campaign.

Destructuring the Response

data DescribeCampaignResponse

See: newDescribeCampaignResponse smart constructor.

Constructors

DescribeCampaignResponse'

Fields

• campaign :: Maybe Campaign

  The properties of the campaign.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeCampaignResponse

Defined in Amazonka.Personalize.DescribeCampaign

Associated Types

type Rep DescribeCampaignResponse :: Type -> Type

Methods

from :: DescribeCampaignResponse -> Rep DescribeCampaignResponse x

to :: Rep DescribeCampaignResponse x -> DescribeCampaignResponse

Read DescribeCampaignResponse

Defined in Amazonka.Personalize.DescribeCampaign

Methods

readsPrec :: Int -> ReadS DescribeCampaignResponse

readList :: ReadS [DescribeCampaignResponse]

readPrec :: ReadPrec DescribeCampaignResponse

readListPrec :: ReadPrec [DescribeCampaignResponse]

Show DescribeCampaignResponse

Defined in Amazonka.Personalize.DescribeCampaign

Methods

showsPrec :: Int -> DescribeCampaignResponse -> ShowS

show :: DescribeCampaignResponse -> String

showList :: [DescribeCampaignResponse] -> ShowS

NFData DescribeCampaignResponse

Defined in Amazonka.Personalize.DescribeCampaign

Methods

rnf :: DescribeCampaignResponse -> ()

Eq DescribeCampaignResponse

Defined in Amazonka.Personalize.DescribeCampaign

Methods

(==) :: DescribeCampaignResponse -> DescribeCampaignResponse -> Bool

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

type Rep DescribeCampaignResponse

Defined in Amazonka.Personalize.DescribeCampaign

type Rep DescribeCampaignResponse = D1 ('MetaData "DescribeCampaignResponse" "Amazonka.Personalize.DescribeCampaign" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "DescribeCampaignResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaign") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Campaign)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeCampaignResponse

Arguments

:: Int

$sel:httpStatus:DescribeCampaignResponse'

-> DescribeCampaignResponse

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)

The properties of the campaign.

describeCampaignResponse_httpStatus :: Lens' DescribeCampaignResponse Int

The response's http status code.