inbound_integrations
Creates, updates, deletes, gets or lists an inbound_integrations resource.
Overview
| Name | inbound_integrations |
| Type | Resource |
| Id | aws.redshift.inbound_integrations |
Fields
The following fields are returned by SELECT queries:
- describe_inbound_integrations
| Name | Datatype | Description |
|---|---|---|
create_time | string | The creation time of an inbound integration. |
errors | string | The outstanding errors of an inbound integration. Each item is an "IntegrationError". This is null if there is no error. |
integration_arn | string | The Amazon Resource Name (ARN) of an inbound integration. |
source_arn | string | The Amazon Resource Name (ARN) of the source of an inbound integration. |
status | string | The status of an inbound integration. |
target_arn | string | The Amazon Resource Name (ARN) of the target of an inbound integration. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_inbound_integrations | select | region | IntegrationArn, TargetArn, MaxRecords, Marker | Returns a list of inbound integrations. |
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) |
IntegrationArn | string | The Amazon Resource Name (ARN) of the inbound integration. |
Marker | string | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeInboundIntegrations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. |
MaxRecords | integer | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. |
TargetArn | string | The Amazon Resource Name (ARN) of the target of an inbound integration. |
SELECT examples
- describe_inbound_integrations
Returns a list of inbound integrations.
SELECT
create_time,
errors,
integration_arn,
source_arn,
status,
target_arn
FROM aws.redshift.inbound_integrations
WHERE region = '{{ region }}' -- required
AND IntegrationArn = '{{ IntegrationArn }}'
AND TargetArn = '{{ TargetArn }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;