DescribeApplication
Retrieves the details of an application associated with an instance of IAM Identity Center.
Request Syntax
{
"ApplicationArn": "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.
- ApplicationArn
-
Specifies the ARN of the application. 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::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}Required: Yes
Response Syntax
{
"ApplicationAccount": "string",
"ApplicationArn": "string",
"ApplicationProviderArn": "string",
"CreatedDate": number,
"Description": "string",
"InstanceArn": "string",
"Name": "string",
"PortalOptions": {
"SignInOptions": {
"ApplicationUrl": "string",
"Origin": "string"
},
"Visibility": "string"
},
"Status": "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.
- ApplicationAccount
-
The account ID.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
\d{12} - ApplicationArn
-
Specifies the 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} - ApplicationProviderArn
-
The ARN of the application provider under which the operation will run.
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::aws:applicationProvider/[a-zA-Z0-9-/]+ - CreatedDate
-
The date the application was created.
Type: Timestamp
- Description
-
The description of the Application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
- InstanceArn
-
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 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} - Name
-
The application name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
[\w+=,.@-]+ - PortalOptions
-
A structure that describes the options for the portal associated with an application.
Type: PortalOptions object
- Status
-
Specifies whether the application is enabled or disabled.
Type: String
Valid Values:
ENABLED | DISABLED
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
- ResourceNotFoundException
-
Indicates that a requested resource is not found.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
