Amazonka.Synthetics.DescribeCanariesLastRun

Use this operation to see information from the most recent run of each canary that you have created.

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Creating a Request

data DescribeCanariesLastRun

See: newDescribeCanariesLastRun smart constructor.

Constructors

DescribeCanariesLastRun'

Fields

• maxResults :: Maybe Natural

  Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used.

• names :: Maybe (NonEmpty Text)

  Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

  If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

  You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

• nextToken :: Maybe Text

  A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.

Instances

ToJSON DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

toJSON :: DescribeCanariesLastRun -> Value

toEncoding :: DescribeCanariesLastRun -> Encoding

toJSONList :: [DescribeCanariesLastRun] -> Value

toEncodingList :: [DescribeCanariesLastRun] -> Encoding

ToHeaders DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

toHeaders :: DescribeCanariesLastRun -> [Header]

ToPath DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

toPath :: DescribeCanariesLastRun -> ByteString

ToQuery DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

toQuery :: DescribeCanariesLastRun -> QueryString

AWSRequest DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Associated Types

type AWSResponse DescribeCanariesLastRun

Methods

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

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

Generic DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Associated Types

type Rep DescribeCanariesLastRun :: Type -> Type

Methods

from :: DescribeCanariesLastRun -> Rep DescribeCanariesLastRun x

to :: Rep DescribeCanariesLastRun x -> DescribeCanariesLastRun

Read DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

readsPrec :: Int -> ReadS DescribeCanariesLastRun

readList :: ReadS [DescribeCanariesLastRun]

readPrec :: ReadPrec DescribeCanariesLastRun

readListPrec :: ReadPrec [DescribeCanariesLastRun]

Show DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

showsPrec :: Int -> DescribeCanariesLastRun -> ShowS

show :: DescribeCanariesLastRun -> String

showList :: [DescribeCanariesLastRun] -> ShowS

NFData DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

rnf :: DescribeCanariesLastRun -> ()

Eq DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

(==) :: DescribeCanariesLastRun -> DescribeCanariesLastRun -> Bool

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

Hashable DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

hashWithSalt :: Int -> DescribeCanariesLastRun -> Int

hash :: DescribeCanariesLastRun -> Int

type AWSResponse DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

type AWSResponse DescribeCanariesLastRun = DescribeCanariesLastRunResponse

type Rep DescribeCanariesLastRun

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

type Rep DescribeCanariesLastRun = D1 ('MetaData "DescribeCanariesLastRun" "Amazonka.Synthetics.DescribeCanariesLastRun" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "DescribeCanariesLastRun'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeCanariesLastRun :: DescribeCanariesLastRun

Create a value of DescribeCanariesLastRun 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:maxResults:DescribeCanariesLastRun', describeCanariesLastRun_maxResults - Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used.

$sel:names:DescribeCanariesLastRun', describeCanariesLastRun_names - Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

DescribeCanariesLastRun, describeCanariesLastRun_nextToken - A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.

Request Lenses

describeCanariesLastRun_maxResults :: Lens' DescribeCanariesLastRun (Maybe Natural)

Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used.

describeCanariesLastRun_names :: Lens' DescribeCanariesLastRun (Maybe (NonEmpty Text))

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

describeCanariesLastRun_nextToken :: Lens' DescribeCanariesLastRun (Maybe Text)

A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.

Destructuring the Response

data DescribeCanariesLastRunResponse

See: newDescribeCanariesLastRunResponse smart constructor.

Constructors

DescribeCanariesLastRunResponse'

Fields

• canariesLastRun :: Maybe [CanaryLastRun]

  An array that contains the information from the most recent run of each canary.

• nextToken :: Maybe Text

  A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeCanariesLastRunResponse

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Associated Types

type Rep DescribeCanariesLastRunResponse :: Type -> Type

Methods

from :: DescribeCanariesLastRunResponse -> Rep DescribeCanariesLastRunResponse x

to :: Rep DescribeCanariesLastRunResponse x -> DescribeCanariesLastRunResponse

Read DescribeCanariesLastRunResponse

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

readsPrec :: Int -> ReadS DescribeCanariesLastRunResponse

readList :: ReadS [DescribeCanariesLastRunResponse]

readPrec :: ReadPrec DescribeCanariesLastRunResponse

readListPrec :: ReadPrec [DescribeCanariesLastRunResponse]

Show DescribeCanariesLastRunResponse

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

showsPrec :: Int -> DescribeCanariesLastRunResponse -> ShowS

show :: DescribeCanariesLastRunResponse -> String

showList :: [DescribeCanariesLastRunResponse] -> ShowS

NFData DescribeCanariesLastRunResponse

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

rnf :: DescribeCanariesLastRunResponse -> ()

Eq DescribeCanariesLastRunResponse

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

Methods

(==) :: DescribeCanariesLastRunResponse -> DescribeCanariesLastRunResponse -> Bool

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

type Rep DescribeCanariesLastRunResponse

Defined in Amazonka.Synthetics.DescribeCanariesLastRun

type Rep DescribeCanariesLastRunResponse = D1 ('MetaData "DescribeCanariesLastRunResponse" "Amazonka.Synthetics.DescribeCanariesLastRun" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "DescribeCanariesLastRunResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "canariesLastRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CanaryLastRun])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCanariesLastRunResponse

Arguments

:: Int

$sel:httpStatus:DescribeCanariesLastRunResponse'

-> DescribeCanariesLastRunResponse

Create a value of DescribeCanariesLastRunResponse 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:canariesLastRun:DescribeCanariesLastRunResponse', describeCanariesLastRunResponse_canariesLastRun - An array that contains the information from the most recent run of each canary.

DescribeCanariesLastRun, describeCanariesLastRunResponse_nextToken - A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.

$sel:httpStatus:DescribeCanariesLastRunResponse', describeCanariesLastRunResponse_httpStatus - The response's http status code.

Response Lenses

describeCanariesLastRunResponse_canariesLastRun :: Lens' DescribeCanariesLastRunResponse (Maybe [CanaryLastRun])

An array that contains the information from the most recent run of each canary.

describeCanariesLastRunResponse_nextToken :: Lens' DescribeCanariesLastRunResponse (Maybe Text)

A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.

describeCanariesLastRunResponse_httpStatus :: Lens' DescribeCanariesLastRunResponse Int

The response's http status code.