Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateApplication

Updates and persists an Application resource.

Request Syntax


PATCH /applications/ApplicationIdentifier HTTP/1.1
Content-type: application/json

{
   "ApplicationConfig": { 
      "ContactHandling": { 
         "Scope": "string"
      }
   },
   "ApplicationSourceConfig": { 
      "ExternalUrlConfig": { 
         "AccessUrl": "string",
         "ApprovedOrigins": [ "string" ]
      }
   },
   "Description": "string",
   "IframeConfig": { 
      "Allow": [ "string" ],
      "Sandbox": [ "string" ]
   },
   "InitializationTimeout": number,
   "IsService": boolean,
   "Name": "string",
   "Permissions": [ "string" ],
   "Publications": [ 
      { 
         "Description": "string",
         "Event": "string",
         "Schema": "string"
      }
   ],
   "Subscriptions": [ 
      { 
         "Description": "string",
         "Event": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

ApplicationIdentifier

The Amazon Resource Name (ARN) of the Application.

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

Pattern: ^(arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})(:[\w\$]+)?$

Required: Yes

Request Body

The request accepts the following data in JSON format.

ApplicationConfig

The configuration settings for the application.

Type: ApplicationConfig object

Required: No

ApplicationSourceConfig

The configuration for where the application should be loaded from.

Type: ApplicationSourceConfig object

Required: No

Description

The description of the application.

Type: String

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

Pattern: .*

Required: No

IframeConfig

The iframe configuration for the application.

Type: IframeConfig object

Required: No

InitializationTimeout

The maximum time in milliseconds allowed to establish a connection with the workspace.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 600000.

Required: No

IsService

Indicates whether the application is a service.

Type: Boolean

Required: No

Name

The name of the application.

Type: String

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

Pattern: ^[a-zA-Z0-9\/\._ \-]+$

Required: No

Permissions

The configuration of events or requests that the application has access to.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 150 items.

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

Pattern: ^[a-zA-Z0-9\/\._\-\*]+$

Required: No

Publications

This parameter has been deprecated.

The events that the application publishes.

Type: Array of Publication objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Subscriptions

This parameter has been deprecated.

The events that the application subscribes.

Type: Array of Subscription objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 200

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: 403

InternalServiceError

Request processing failed due to an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400