applications

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

Overview

Name	`applications`
Type	Resource
Id	`aws.sso_admin.applications`

Fields

The following fields are returned by SELECT queries:

describe_application
list_applications

Name	Datatype	Description
`application_account`	`string`	The account ID. (pattern: <code>\d{12}</code>)
`application_arn`	`string`	Specifies the ARN of the application. (pattern: <code>arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}</code>)
`application_provider_arn`	`string`	The ARN of the application provider under which the operation will run. (pattern: <code>arn:aws(-[a-z]{1,5}){0,3}:sso::aws:applicationProvider/[a-zA-Z0-9-/]+</code>)
`created_date`	`string (date-time)`	The date the application was created.
`created_from`	`string`	The Amazon Web Services Region where the application was created in IAM Identity Center. (pattern: <code>([a-z]+-){2,3}\d</code>)
`description`	`string`	The description of the .
`identity_store_arn`	`string`	The ARN of the identity store that is connected to the instance of IAM Identity Center.
`instance_arn`	`string`	The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference. (pattern: <code>arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}</code>)
`name`	`string`	The application name. (pattern: <code>[\S\s]*</code>)
`portal_options`	`object`	A structure that describes the options for the portal associated with an application.
`status`	`string`	Specifies whether the application is enabled or disabled. (ENABLED, DISABLED)

Name	Datatype	Description
`application_account`	`string`	The Amazon Web Services account ID number of the application. (pattern: <code>\d{12}</code>)
`application_arn`	`string`	The ARN of the application. (pattern: <code>arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}</code>)
`application_provider_arn`	`string`	The ARN of the application provider for this application. (pattern: <code>arn:aws(-[a-z]{1,5}){0,3}:sso::aws:applicationProvider/[a-zA-Z0-9-/]+</code>)
`created_date`	`string (date-time)`	The date and time when the application was originally created.
`created_from`	`string`	The Amazon Web Services Region where the application was created in IAM Identity Center. (pattern: <code>([a-z]+-){2,3}\d</code>)
`description`	`string`	The description of the application.
`identity_store_arn`	`string`	The ARN of the identity store that is connected to the instance of IAM Identity Center.
`instance_arn`	`string`	The ARN of the instance of IAM Identity Center that is configured with this application. (pattern: <code>arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}</code>)
`name`	`string`	The name of the application. (pattern: <code>[\S\s]*</code>)
`portal_options`	`object`	A structure that describes the options for the access portal associated with this application.
`status`	`string`	The current status of the application in this instance of IAM Identity Center. (ENABLED, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_application`	`select`	`region`	Retrieves the details of an application associated with an instance of IAM Identity Center.
`list_applications`	`select`	`region`	Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.
`create_application`	`insert`	`region`, `InstanceArn`, `ApplicationProviderArn`	Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider. This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.
`update_application`	`update`	`region`, `ApplicationArn`	Updates application properties.
`delete_application`	`delete`	`region`	Deletes the association with the application. The connected service resource still exists.

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)

`SELECT` examples

describe_application
list_applications

Retrieves the details of an application associated with an instance of IAM Identity Center.

SELECT
application_account,
application_arn,
application_provider_arn,
created_date,
created_from,
description,
identity_store_arn,
instance_arn,
name,
portal_options,
status
FROM aws.sso_admin.applications
WHERE region = '{{ region }}' -- required
;

Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.

SELECT
application_account,
application_arn,
application_provider_arn,
created_date,
created_from,
description,
identity_store_arn,
instance_arn,
name,
portal_options,
status
FROM aws.sso_admin.applications
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_application
Manifest

Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider. This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.

INSERT INTO aws.sso_admin.applications (
InstanceArn,
ApplicationProviderArn,
Name,
Description,
PortalOptions,
Tags,
Status,
ClientToken,
region
)
SELECT 
'{{ InstanceArn }}' /* required */,
'{{ ApplicationProviderArn }}' /* required */,
'{{ Name }}',
'{{ Description }}',
'{{ PortalOptions }}',
'{{ Tags }}',
'{{ Status }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
application_arn,
identity_store_arn,
instance_arn
;

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: InstanceArn
    value: "{{ InstanceArn }}"
    description: |
      The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
  - name: ApplicationProviderArn
    value: "{{ ApplicationProviderArn }}"
    description: |
      The ARN of the application provider under which the operation will run.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the .
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the .
  - name: PortalOptions
    description: |
      A structure that describes the options for the portal associated with an application.
    value:
      SignInOptions:
        Origin: "{{ Origin }}"
        ApplicationUrl: "{{ ApplicationUrl }}"
      Visibility: "{{ Visibility }}"
  - name: Tags
    description: |
      Specifies tags to be attached to the application.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: Status
    value: "{{ Status }}"
    description: |
      Specifies whether the application is enabled or disabled.
    valid_values: ['ENABLED', 'DISABLED']
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

`UPDATE` examples

update_application

Updates application properties.

UPDATE aws.sso_admin.applications
SET 
ApplicationArn = '{{ ApplicationArn }}',
Name = '{{ Name }}',
Description = '{{ Description }}',
Status = '{{ Status }}',
PortalOptions = '{{ PortalOptions }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationArn = '{{ ApplicationArn }}' --required;

`DELETE` examples

delete_application

Deletes the association with the application. The connected service resource still exists.

DELETE FROM aws.sso_admin.applications
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​