groups_for_capacity_reservations

Creates, updates, deletes, gets or lists a groups_for_capacity_reservations resource.

Overview

Name	groups_for_capacity_reservations
Type	Resource
Id	aws.ec2.groups_for_capacity_reservations

Fields

The following fields are returned by SELECT queries:

get_groups_for_capacity_reservation

Name	Datatype	Description
group_arn	string	The ARN of the resource group.
owner_id	string	The ID of the Amazon Web Services account that owns the resource group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_groups_for_capacity_reservation	select	CapacityReservationId, region	NextToken, MaxResults, DryRun	Lists the resource groups to which a Capacity Reservation has been added.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
CapacityReservationId	string	The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own.
region	string	AWS region (default: us-east-1)
DryRun	boolean	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.
MaxResults	integer	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.
NextToken	string	The token to use to retrieve the next page of results.

SELECT examples

get_groups_for_capacity_reservation

Lists the resource groups to which a Capacity Reservation has been added.

SELECT
group_arn,
owner_id
FROM aws.ec2.groups_for_capacity_reservations
WHERE CapacityReservationId = '{{ CapacityReservationId }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND DryRun = '{{ DryRun }}'
;