Interface DescribeCanariesLastRunRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeCanariesLastRunRequest.Builder,
,DescribeCanariesLastRunRequest> SdkBuilder<DescribeCanariesLastRunRequest.Builder,
,DescribeCanariesLastRunRequest> SdkPojo
,SdkRequest.Builder
,SyntheticsRequest.Builder
- Enclosing class:
DescribeCanariesLastRunRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) Specify this parameter to limit how many runs are returned each time you use theDescribeLastRun
operation.Use this parameter to return only canaries that match the names that you specify here.names
(Collection<String> names) Use this parameter to return only canaries that match the names that you specify here.A token that indicates that there is more data available.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.synthetics.model.SyntheticsRequest.Builder
build
-
Method Details
-
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.- Parameters:
nextToken
- A token that indicates that there is more data available. You can use this token in a subsequentDescribeCanariesLastRun
operation to retrieve the next set of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
maxResults
- Specify this parameter to limit how many runs are returned each time you use theDescribeLastRun
operation. If you omit this parameter, the default of 100 is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeCanariesLastRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeCanariesLastRunRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-