autoshifts
Creates, updates, deletes, gets or lists an autoshifts resource.
Overview
| Name | autoshifts |
| Type | Resource |
| Id | aws.arc_zonal_shift.autoshifts |
Fields
The following fields are returned by SELECT queries:
- list_autoshifts
| Name | Datatype | Description |
|---|---|---|
away_from | string | The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource. |
end_time | string (date-time) | The time (in UTC) when the autoshift ended. |
start_time | string (date-time) | The time (in UTC) when the autoshift started. |
status | string | The status for an autoshift. (ACTIVE, COMPLETED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_autoshifts | select | region | nextToken, status, maxResults | Returns the autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts. |
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 number of objects that you want to return with this call. |
nextToken | string | Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results. |
status | string | The status of the autoshift. |
SELECT examples
- list_autoshifts
Returns the autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.
SELECT
away_from,
end_time,
start_time,
status
FROM aws.arc_zonal_shift.autoshifts
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND status = '{{ status }}'
AND maxResults = '{{ maxResults }}'
;