Package software.amazon.awssdk.services.ec2.model

Interface DescribeTagsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>, Ec2Request.Builder, SdkBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeTagsRequest
@Mutable @NotThreadSafe public static interface DescribeTagsRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>

  • Method Details

    • dryRun

      DescribeTagsRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeTagsRequest.Builder filters(Collection<Filter> filters)

      The filters.

      • key - The tag key.

      • resource-id - The ID of the resource.

      • resource-type - The resource type. For a list of possible values, see TagSpecification.

      • tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".

      • value - The tag value.

      Parameters:
      filters - The filters.

      • key - The tag key.

      • resource-id - The ID of the resource.

      • resource-type - The resource type. For a list of possible values, see TagSpecification.

      • tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".

      • value - The tag value.

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

    • filters

      DescribeTagsRequest.Builder filters(Filter... filters)

      The filters.

      • key - The tag key.

      • resource-id - The ID of the resource.

      • resource-type - The resource type. For a list of possible values, see TagSpecification.

      • tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".

      • value - The tag value.

      Parameters:
      filters - The filters.

      • key - The tag key.

      • resource-id - The ID of the resource.

      • resource-type - The resource type. For a list of possible values, see TagSpecification.

      • tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".

      • value - The tag value.

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

    • filters

      DescribeTagsRequest.Builder filters(Consumer<Filter.Builder>... filters)

      The filters.

      • key - The tag key.

      • resource-id - The ID of the resource.

      • resource-type - The resource type. For a list of possible values, see TagSpecification.

      • tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".

      • value - The tag value.

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      DescribeTagsRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

      Parameters:
      maxResults - The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeTagsRequest.Builder nextToken(String nextToken)

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

      Parameters:
      nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeTagsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      DescribeTagsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder