resources
Creates, updates, deletes, gets or lists a resources resource.
Overview
| Name | resources |
| Type | Resource |
| Id | aws.ram.resources |
Fields
The following fields are returned by SELECT queries:
- list_resources
| Name | Datatype | Description |
|---|---|---|
arn | string | The Amazon Resource Name (ARN) of the resource. |
creation_time | string (date-time) | The date and time when the resource was associated with the resource share. |
last_updated_time | string (date-time) | The date an time when the association between the resource and the resource share was last updated. |
resource_group_arn | string | The Amazon Resource Name (ARN) of the resource group. This value is available only if the resource is part of a resource group. |
resource_region_scope | string | Specifies the scope of visibility of this resource: REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists. GLOBAL – The resource can be accessed from any Amazon Web Services Region. (REGIONAL, GLOBAL) |
resource_share_arn | string | The Amazon Resource Name (ARN) of the resource share this resource is associated with. |
status | string | The current status of the resource. (AVAILABLE, ZONAL_RESOURCE_INACCESSIBLE, LIMIT_EXCEEDED, UNAVAILABLE, PENDING) |
status_message | string | A message about the status of the resource. |
type_ | string | The resource type. This takes the form of: service-code:resource-code, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string ec2:subnet. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_resources | select | region | Lists the resources that you added to a resource share or the resources that are shared with you. Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_resources
Lists the resources that you added to a resource share or the resources that are shared with you. Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
SELECT
arn,
creation_time,
last_updated_time,
resource_group_arn,
resource_region_scope,
resource_share_arn,
status,
status_message,
type_
FROM aws.ram.resources
WHERE region = '{{ region }}' -- required
;