applications

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

Overview

Name	applications
Type	Resource
Id	aws.account_access.applications

Fields

The following fields are returned by SELECT queries:

get_application

Name	Datatype	Description
created_at	string (date-time)	The date and time when the application was created.
error	object	The error details if the application is in a failed state.
identity_source	object	The identity source details for the application, including the IAM Identity Center instance configuration.
status	string	The current status of the application. (CREATE_IN_PROGRESS, ACTIVE, DELETE_IN_PROGRESS, CREATE_FAILED, DELETE_FAILED)
tags	object	The tags associated with the application.
tenant_id	string	The tenant identifier associated with the application.
updated_at	string (date-time)	The date and time when the application was last updated.

list_applications

Name	Datatype	Description
application_arn	string	The ARN of the application. (pattern: <code>arn:[a-z0-9-]+:account-access:[a-z0-9]+(-[a-z0-9]+)*:[0-9]{12}:application/[a-zA-Z0-9-]+</code>)
created_at	string (date-time)	The date and time when the application was created.
tenant_id	string	The tenant identifier associated with the application.
updated_at	string (date-time)	The date and time when the application was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application	select	application_arn, region		Retrieves details about an account access manager application, including its status, identity source, and tags.
list_applications	select	region		Lists the account access manager applications in your account. Use pagination to ensure that the operation returns quickly and successfully.
create_application	insert	region, identitySource		Creates an account access manager instance and its Amazon Web Services account access application in the associated IAM Identity Center instance. This operation is idempotent; calling it multiple times with the same parameters returns the existing application.
delete_application	delete	application_arn, region		Deletes an account access manager application. This operation is idempotent; deleting an application that has already been deleted does not return an error.

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
application_arn	string	Specifies the ARN of the application to delete.
region	string	AWS region (default: us-east-1)

SELECT examples

get_application

Retrieves details about an account access manager application, including its status, identity source, and tags.

SELECT
created_at,
error,
identity_source,
status,
tags,
tenant_id,
updated_at
FROM aws.account_access.applications
WHERE application_arn = '{{ application_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_applications

Lists the account access manager applications in your account. Use pagination to ensure that the operation returns quickly and successfully.

SELECT
application_arn,
created_at,
tenant_id,
updated_at
FROM aws.account_access.applications
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_application

Creates an account access manager instance and its Amazon Web Services account access application in the associated IAM Identity Center instance. This operation is idempotent; calling it multiple times with the same parameters returns the existing application.

INSERT INTO aws.account_access.applications (
identitySource,
tags,
region
)
SELECT 
'{{ identitySource }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
application_arn
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: identitySource
    description: |
      Specifies the identity source for an account access manager application.
    value:
      identityCenter:
        instanceArn: "{{ instanceArn }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_application

Deletes an account access manager application. This operation is idempotent; deleting an application that has already been deleted does not return an error.

DELETE FROM aws.account_access.applications
WHERE application_arn = '{{ application_arn }}' --required
AND region = '{{ region }}' --required
;