| 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.Synthetics.DescribeCanariesLastRun
Description
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.
Synopsis
- data DescribeCanariesLastRun = DescribeCanariesLastRun' {}
- newDescribeCanariesLastRun :: DescribeCanariesLastRun
- describeCanariesLastRun_maxResults :: Lens' DescribeCanariesLastRun (Maybe Natural)
- describeCanariesLastRun_names :: Lens' DescribeCanariesLastRun (Maybe (NonEmpty Text))
- describeCanariesLastRun_nextToken :: Lens' DescribeCanariesLastRun (Maybe Text)
- data DescribeCanariesLastRunResponse = DescribeCanariesLastRunResponse' {
- canariesLastRun :: Maybe [CanaryLastRun]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeCanariesLastRunResponse :: Int -> DescribeCanariesLastRunResponse
- describeCanariesLastRunResponse_canariesLastRun :: Lens' DescribeCanariesLastRunResponse (Maybe [CanaryLastRun])
- describeCanariesLastRunResponse_nextToken :: Lens' DescribeCanariesLastRunResponse (Maybe Text)
- describeCanariesLastRunResponse_httpStatus :: Lens' DescribeCanariesLastRunResponse Int
Creating a Request
data DescribeCanariesLastRun Source #
See: newDescribeCanariesLastRun smart constructor.
Constructors
| DescribeCanariesLastRun' | |
Fields
| |
Instances
newDescribeCanariesLastRun :: DescribeCanariesLastRun Source #
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) Source #
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)) Source #
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) Source #
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 Source #
See: newDescribeCanariesLastRunResponse smart constructor.
Constructors
| DescribeCanariesLastRunResponse' | |
Fields
| |
Instances
newDescribeCanariesLastRunResponse Source #
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]) Source #
An array that contains the information from the most recent run of each canary.
describeCanariesLastRunResponse_nextToken :: Lens' DescribeCanariesLastRunResponse (Maybe Text) Source #
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 Source #
The response's http status code.