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

Interface DescribeInstanceImageMetadataRequest.Builder

    • Method Detail

      • filters

        DescribeInstanceImageMetadataRequest.Builder filters​(Collection<Filter> filters)

        The filters.

        • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) of the instance.

        • instance-id - The ID of the instance.

        • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

        • instance-type - The type of instance (for example, t3.micro).

        • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2023-09-29T11:04:43.305Z. You can use a wildcard ( *), for example, 2023-09-29T*, which matches an entire day.

        • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

        • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) of the instance.

        Parameters:
        filters - The filters.

        • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) of the instance.

        • instance-id - The ID of the instance.

        • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

        • instance-type - The type of instance (for example, t3.micro).

        • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2023-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2023-09-29T*, which matches an entire day.

        • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

        • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) of the instance.

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

      • filters

        DescribeInstanceImageMetadataRequest.Builder filters​(Filter... filters)

        The filters.

        • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) of the instance.

        • instance-id - The ID of the instance.

        • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

        • instance-type - The type of instance (for example, t3.micro).

        • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2023-09-29T11:04:43.305Z. You can use a wildcard ( *), for example, 2023-09-29T*, which matches an entire day.

        • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

        • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) of the instance.

        Parameters:
        filters - The filters.

        • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) of the instance.

        • instance-id - The ID of the instance.

        • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

        • instance-type - The type of instance (for example, t3.micro).

        • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2023-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2023-09-29T*, which matches an entire day.

        • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

        • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) of the instance.

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

      • filters

        DescribeInstanceImageMetadataRequest.Builder filters​(Consumer<Filter.Builder>... filters)

        The filters.

        • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) of the instance.

        • instance-id - The ID of the instance.

        • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

        • instance-type - The type of instance (for example, t3.micro).

        • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2023-09-29T11:04:43.305Z. You can use a wildcard ( *), for example, 2023-09-29T*, which matches an entire day.

        • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

        • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) of the instance.

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

        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:
        #filters(java.util.Collection)

      • instanceIds

        DescribeInstanceImageMetadataRequest.Builder instanceIds​(Collection<String> instanceIds)

        The instance IDs.

        If you don't specify an instance ID or filters, the output includes information for all instances.

        Parameters:
        instanceIds - The instance IDs.

        If you don't specify an instance ID or filters, the output includes information for all instances.

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

      • instanceIds

        DescribeInstanceImageMetadataRequest.Builder instanceIds​(String... instanceIds)

        The instance IDs.

        If you don't specify an instance ID or filters, the output includes information for all instances.

        Parameters:
        instanceIds - The instance IDs.

        If you don't specify an instance ID or filters, the output includes information for all instances.

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

      • maxResults

        DescribeInstanceImageMetadataRequest.Builder maxResults​(Integer maxResults)

        The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

        Default: 1000

        Parameters:
        maxResults - The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

        Default: 1000

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

      • nextToken

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

      • dryRun

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