identity_sources

Creates, updates, deletes, gets or lists an identity_sources resource.

Overview

Name	identity_sources
Type	Resource
Id	aws.mpa.identity_sources

Fields

The following fields are returned by SELECT queries:

get_identity_source

Name	Datatype	Description
creation_time	string (date-time)	Timestamp when the identity source was created.
identity_source_arn	string	Amazon Resource Name (ARN) for the identity source.
identity_source_parameters	object	A IdentitySourceParameters object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.
identity_source_type	string	The type of resource that provided identities to the identity source. For example, an IAM Identity Center instance. (IAM_IDENTITY_CENTER)
status	string	Status for the identity source. For example, if the identity source is ACTIVE. (CREATING, ACTIVE, DELETING, ERROR)
status_code	string	Status code of the identity source. (ACCESS_DENIED, DELETION_FAILED, IDC_INSTANCE_NOT_FOUND, IDC_INSTANCE_NOT_VALID)
status_message	string	Message describing the status for the identity source.

list_identity_sources

Name	Datatype	Description
creation_time	string (date-time)	Timestamp when the identity source was created.
identity_source_arn	string	Amazon Resource Name (ARN) for the identity source.
identity_source_parameters	object	A IdentitySourceParametersForList object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.
identity_source_type	string	The type of resource that provided identities to the identity source. For example, an IAM Identity Center instance. (IAM_IDENTITY_CENTER)
status	string	Status for the identity source. For example, if the identity source is ACTIVE. (CREATING, ACTIVE, DELETING, ERROR)
status_code	string	Status code of the identity source. (ACCESS_DENIED, DELETION_FAILED, IDC_INSTANCE_NOT_FOUND, IDC_INSTANCE_NOT_VALID)
status_message	string	Message describing the status for the identity source.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_identity_source	select	identity_source_arn, region		Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
list_identity_sources	select	region	MaxResults, NextToken	Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.
create_identity_source	insert	region, IdentitySourceParameters		Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.
delete_identity_source	delete	identity_source_arn, region		Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

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
identity_source_arn	string	Amazon Resource Name (ARN) for identity source.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
NextToken	string	If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

SELECT examples

get_identity_source

Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

SELECT
creation_time,
identity_source_arn,
identity_source_parameters,
identity_source_type,
status,
status_code,
status_message
FROM aws.mpa.identity_sources
WHERE identity_source_arn = '{{ identity_source_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_identity_sources

Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.

SELECT
creation_time,
identity_source_arn,
identity_source_parameters,
identity_source_type,
status,
status_code,
status_message
FROM aws.mpa.identity_sources
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_identity_source

Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.

INSERT INTO aws.mpa.identity_sources (
IdentitySourceParameters,
ClientToken,
Tags,
region
)
SELECT 
'{{ IdentitySourceParameters }}' /* required */,
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
creation_time,
identity_source_arn,
identity_source_type
;

Manifest

# Description fields are for documentation purposes
- name: identity_sources
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the identity_sources resource.
  - name: IdentitySourceParameters
    description: |
      Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.
    value:
      IamIdentityCenter:
        InstanceArn: "{{ InstanceArn }}"
        Region: "{{ Region }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_identity_source

Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

DELETE FROM aws.mpa.identity_sources
WHERE identity_source_arn = '{{ identity_source_arn }}' --required
AND region = '{{ region }}' --required
;