| 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.DescribeCanaries
Description
This operation returns a list of the canaries in your account, along with full details about each canary.
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 DescribeCanaries = DescribeCanaries' {}
- newDescribeCanaries :: DescribeCanaries
- describeCanaries_maxResults :: Lens' DescribeCanaries (Maybe Natural)
- describeCanaries_names :: Lens' DescribeCanaries (Maybe (NonEmpty Text))
- describeCanaries_nextToken :: Lens' DescribeCanaries (Maybe Text)
- data DescribeCanariesResponse = DescribeCanariesResponse' {}
- newDescribeCanariesResponse :: Int -> DescribeCanariesResponse
- describeCanariesResponse_canaries :: Lens' DescribeCanariesResponse (Maybe [Canary])
- describeCanariesResponse_nextToken :: Lens' DescribeCanariesResponse (Maybe Text)
- describeCanariesResponse_httpStatus :: Lens' DescribeCanariesResponse Int
Creating a Request
data DescribeCanaries Source #
See: newDescribeCanaries smart constructor.
Constructors
| DescribeCanaries' | |
Fields
| |
Instances
newDescribeCanaries :: DescribeCanaries Source #
Create a value of DescribeCanaries 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:DescribeCanaries', describeCanaries_maxResults - Specify this parameter to limit how many canaries are returned each time
you use the DescribeCanaries operation. If you omit this parameter,
the default of 100 is used.
$sel:names:DescribeCanaries', describeCanaries_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 this 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.
DescribeCanaries, describeCanaries_nextToken - A token that indicates that there is more data available. You can use
this token in a subsequent operation to retrieve the next set of
results.
Request Lenses
describeCanaries_maxResults :: Lens' DescribeCanaries (Maybe Natural) Source #
Specify this parameter to limit how many canaries are returned each time
you use the DescribeCanaries operation. If you omit this parameter,
the default of 100 is used.
describeCanaries_names :: Lens' DescribeCanaries (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 this 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.
describeCanaries_nextToken :: Lens' DescribeCanaries (Maybe Text) Source #
A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.
Destructuring the Response
data DescribeCanariesResponse Source #
See: newDescribeCanariesResponse smart constructor.
Constructors
| DescribeCanariesResponse' | |
Fields
| |
Instances
newDescribeCanariesResponse Source #
Create a value of DescribeCanariesResponse 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:canaries:DescribeCanariesResponse', describeCanariesResponse_canaries - Returns an array. Each item in the array contains the full information
about one canary.
DescribeCanaries, describeCanariesResponse_nextToken - A token that indicates that there is more data available. You can use
this token in a subsequent DescribeCanaries operation to retrieve the
next set of results.
$sel:httpStatus:DescribeCanariesResponse', describeCanariesResponse_httpStatus - The response's http status code.
Response Lenses
describeCanariesResponse_canaries :: Lens' DescribeCanariesResponse (Maybe [Canary]) Source #
Returns an array. Each item in the array contains the full information about one canary.
describeCanariesResponse_nextToken :: Lens' DescribeCanariesResponse (Maybe Text) Source #
A token that indicates that there is more data available. You can use
this token in a subsequent DescribeCanaries operation to retrieve the
next set of results.
describeCanariesResponse_httpStatus :: Lens' DescribeCanariesResponse Int Source #
The response's http status code.