Request Syntax Request Parameters Response Elements Errors See Also

UpdateApplication

Updates application properties.

Request Syntax


{
   "ApplicationArn": "string",
   "Description": "string",
   "Name": "string",
   "PortalOptions": { 
      "SignInOptions": { 
         "ApplicationUrl": "string",
         "Origin": "string"
      }
   },
   "Status": "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

Description

The description of the Application.

Type: String

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

Required: No

Name

Specifies the updated name for the application.

Type: String

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

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

Required: No

PortalOptions

A structure that describes the options for the portal associated with an application.

Type: UpdateApplicationPortalOptions object

Required: No

Status

Specifies whether the application is enabled or disabled.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Elements

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

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

ConflictException

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

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