CreateApplication - Amazon Connect

CreateApplication

Creates and persists an Application resource.

Request Syntax

POST /applications HTTP/1.1 Content-type: application/json { "ApplicationSourceConfig": { "ExternalUrlConfig": { "AccessUrl": "string", "ApprovedOrigins": [ "string" ] } }, "ClientToken": "string", "Description": "string", "Name": "string", "Namespace": "string", "Permissions": [ "string" ], "Publications": [ { "Description": "string", "Event": "string", "Schema": "string" } ], "Subscriptions": [ { "Description": "string", "Event": "string" } ], "Tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ApplicationSourceConfig

The configuration for where the application should be loaded from.

Type: ApplicationSourceConfig object

Required: Yes

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

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

Pattern: .*

Required: No

Description

The description of the application.

Type: String

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

Pattern: .*

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

Namespace

The namespace of the application.

Type: String

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

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

Required: Yes

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

Tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

Map Entries: Maximum number of 200 items.

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

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "Id": "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.

Arn

The Amazon Resource Name (ARN) of the Application.

Type: String

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}$

Id

A unique identifier for the Application.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

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

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

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

ResourceQuotaExceededException

The allowed quota for the resource has been exceeded.

HTTP Status Code: 429

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: