outposts_with_s3s
Creates, updates, deletes, gets or lists an outposts_with_s3s resource.
Overview
| Name | outposts_with_s3s |
| Type | Resource |
| Id | aws.s3outposts.outposts_with_s3s |
Fields
The following fields are returned by SELECT queries:
- list_outposts_with_s3
| Name | Datatype | Description |
|---|---|---|
capacity_in_bytes | integer (int64) | The Amazon S3 capacity of the outpost in bytes. |
outpost_arn | string | Specifies the unique Amazon Resource Name (ARN) for the outpost. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):outposts:[a-z-0-9]*:[0-9]{12}:outpost/(op-[a-f0-9]{17}|ec2)$</code>) |
outpost_id | string | Specifies the unique identifier for the outpost. (pattern: <code>^(op-[a-f0-9]{17}|\d{12}|ec2)$</code>) |
owner_id | string | Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts. (pattern: <code>^\d{12}$</code>) |
s3_outpost_arn | string | Specifies the unique S3 on Outposts ARN for use with Resource Access Manager (RAM). (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z-0-9]*:[0-9]{12}:outpost/(op-[a-f0-9]{17}|\d{12})/s3$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_outposts_with_s3 | select | region | nextToken, maxResults | Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM). |
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) |
maxResults | integer | The maximum number of Outposts to return. The limit is 100. |
nextToken | string | When you can get additional results from the ListOutpostsWithS3 call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional Outposts. |
SELECT examples
- list_outposts_with_s3
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).
SELECT
capacity_in_bytes,
outpost_arn,
outpost_id,
owner_id,
s3_outpost_arn
FROM aws.s3outposts.outposts_with_s3s
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;