Interface DescribeTagsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>
,Ec2Request.Builder
,SdkBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- DescribeTagsRequest
public static interface DescribeTagsRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.DescribeTagsRequest.Builder
filters(Collection<Filter> filters)
The filters.DescribeTagsRequest.Builder
filters(Consumer<Filter.Builder>... filters)
The filters.DescribeTagsRequest.Builder
filters(Filter... filters)
The filters.DescribeTagsRequest.Builder
maxResults(Integer maxResults)
The maximum number of items to return for this request.DescribeTagsRequest.Builder
nextToken(String nextToken)
The token returned from a previous paginated request.DescribeTagsRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeTagsRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
-
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.services.ec2.model.Ec2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
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 isUnauthorizedOperation
.- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- 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 (customer-gateway
|dedicated-host
|dhcp-options
|elastic-ip
|fleet
|fpga-image
|host-reservation
|image
|instance
|internet-gateway
|key-pair
|launch-template
|natgateway
|network-acl
|network-interface
|placement-group
|reserved-instances
|route-table
|security-group
|snapshot
|spot-instances-request
|subnet
|volume
|vpc
|vpc-endpoint
|vpc-endpoint-service
|vpc-peering-connection
|vpn-connection
|vpn-gateway
). -
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 (customer-gateway
|dedicated-host
|dhcp-options
|elastic-ip
|fleet
|fpga-image
|host-reservation
|image
|instance
|internet-gateway
|key-pair
|launch-template
|natgateway
|network-acl
|network-interface
|placement-group
|reserved-instances
|route-table
|security-group
|snapshot
|spot-instances-request
|subnet
|volume
|vpc
|vpc-endpoint
|vpc-endpoint-service
|vpc-peering-connection
|vpn-connection
|vpn-gateway
). -
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 (customer-gateway
|dedicated-host
|dhcp-options
|elastic-ip
|fleet
|fpga-image
|host-reservation
|image
|instance
|internet-gateway
|key-pair
|launch-template
|natgateway
|network-acl
|network-interface
|placement-group
|reserved-instances
|route-table
|security-group
|snapshot
|spot-instances-request
|subnet
|volume
|vpc
|vpc-endpoint
|vpc-endpoint-service
|vpc-peering-connection
|vpn-connection
|vpn-gateway
). -
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 (customer-gateway
|dedicated-host
|dhcp-options
|elastic-ip
|fleet
|fpga-image
|host-reservation
|image
|instance
|internet-gateway
|key-pair
|launch-template
|natgateway
|network-acl
|network-interface
|placement-group
|reserved-instances
|route-table
|security-group
|snapshot
|spot-instances-request
|subnet
|volume
|vpc
|vpc-endpoint
|vpc-endpoint-service
|vpc-peering-connection
|vpn-connection
|vpn-gateway
). -
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 (customer-gateway
|dedicated-host
|dhcp-options
|elastic-ip
|fleet
|fpga-image
|host-reservation
|image
|instance
|internet-gateway
|key-pair
|launch-template
|natgateway
|network-acl
|network-interface
|placement-group
|reserved-instances
|route-table
|security-group
|snapshot
|spot-instances-request
|subnet
|volume
|vpc
|vpc-endpoint
|vpc-endpoint-service
|vpc-peering-connection
|vpn-connection
|vpn-gateway
). -
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.
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#filters(List
.) - Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection
)
-
-
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 interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeTagsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-