Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateIdentityCenterApplication

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.

Request Syntax


{
   "ClientToken": "string",
   "InstanceArn": "string",
   "Name": "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.

ClientToken

The idempotency token associated with the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x21-\x7e]+

Required: No

InstanceArn

The Amazon Resource Name (ARN) of the instance.

Type: String

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

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

Required: Yes

Name

The name of the IAM Identity Center application.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: ^[\w+=,.@-]+$

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

The Amazon Resource Name (ARN) of the 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::\d{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 Error Types.

InvalidParameterException

Important

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400