Package software.amazon.awssdk.services.synthetics.model

Interface DescribeCanariesRequest.Builder

    • Method Detail

      • nextToken

        DescribeCanariesRequest.Builder nextToken​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        DescribeCanariesRequest.Builder maxResults​(Integer 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • names

        DescribeCanariesRequest.Builder names​(Collection<String> 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • names

        DescribeCanariesRequest.Builder names​(String... 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.