Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateTrustedIdentityPropagationApplicationForConsole

Creates an IAM Identity Center application that represents the AWS Management Console on an IAM Identity Center organization instance. This application supports identity-aware sessions in IAM Identity Center, which enables additional user context to be included in the user's AWS Management Console session.

Request Syntax


{
   "identityCenterInstanceArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

identityCenterInstanceArn

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 AWS Service Namespaces in the AWS General Reference.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Required: Yes

Response Syntax


{
   "applicationArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

applicationArn

Specifies the ARN of the newly created application.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure with an internal server.

HTTP Status Code: 500

SetupFailedException

The request to set up an IAM Identity Center application that represents the AWS Management Console has failed due to one of the following:

LIMIT_EXCEEDED - Indicates that the principal has crossed the permitted number of resources that can be created.
RESOURCE_NOT_FOUND - Indicates that the ARN of an instance of IAM Identity Center is not found.
APPLICATION_ALREADY_EXISTS - Indicates that an IAM Identity Center application that represents the AWS Management Console already exists.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

HTTP Status Code: 400