SDK for PHP 3.x

Client: Aws\SupportApp\SupportAppClient
Service ID: support-app
Version: 2021-08-20

This page describes the parameters and results for the operations of the AWS Support App (2021-08-20), and shows how to use the Aws\SupportApp\SupportAppClient object to call the described operations. This documentation is specific to the 2021-08-20 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateSlackChannelConfiguration ( array $params = [] )
Creates a Slack channel configuration for your Amazon Web Services account.
DeleteAccountAlias ( array $params = [] )
Deletes an alias for an Amazon Web Services account ID.
DeleteSlackChannelConfiguration ( array $params = [] )
Deletes a Slack channel configuration from your Amazon Web Services account.
DeleteSlackWorkspaceConfiguration ( array $params = [] )
Deletes a Slack workspace configuration from your Amazon Web Services account.
GetAccountAlias ( array $params = [] )
Retrieves the alias from an Amazon Web Services account ID.
ListSlackChannelConfigurations ( array $params = [] )
Lists the Slack channel configurations for an Amazon Web Services account.
ListSlackWorkspaceConfigurations ( array $params = [] )
Lists the Slack workspace configurations for an Amazon Web Services account.
PutAccountAlias ( array $params = [] )
Creates or updates an individual alias for each Amazon Web Services account ID.
RegisterSlackWorkspaceForOrganization ( array $params = [] )
Registers a Slack workspace for your Amazon Web Services account.
UpdateSlackChannelConfiguration ( array $params = [] )
Updates the configuration for a Slack channel, such as case update notifications.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListSlackChannelConfigurations
ListSlackWorkspaceConfigurations

Operations

CreateSlackChannelConfiguration

$result = $client->createSlackChannelConfiguration([/* ... */]);
$promise = $client->createSlackChannelConfigurationAsync([/* ... */]);

Creates a Slack channel configuration for your Amazon Web Services account.

  • You can add up to 5 Slack workspaces for your account.

  • You can add up to 20 Slack channels for your account.

A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel.

We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels.

Parameter Syntax

$result = $client->createSlackChannelConfiguration([
    'channelId' => '<string>', // REQUIRED
    'channelName' => '<string>',
    'channelRoleArn' => '<string>', // REQUIRED
    'notifyOnAddCorrespondenceToCase' => true || false,
    'notifyOnCaseSeverity' => 'none|all|high', // REQUIRED
    'notifyOnCreateOrReopenCase' => true || false,
    'notifyOnResolveCase' => true || false,
    'teamId' => '<string>', // REQUIRED
]);

Parameter Details

Members
channelId
Required: Yes
Type: string

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

channelName
Type: string

The name of the Slack channel that you configure for the Amazon Web Services Support App.

channelRoleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

notifyOnAddCorrespondenceToCase
Type: boolean

Whether you want to get notified when a support case has a new correspondence.

notifyOnCaseSeverity
Required: Yes
Type: string

The case severity for a support case that you want to receive notifications.

If you specify high or all, you must specify true for at least one of the following parameters:

  • notifyOnAddCorrespondenceToCase

  • notifyOnCreateOrReopenCase

  • notifyOnResolveCase

If you specify none, the following parameters must be null or false:

  • notifyOnAddCorrespondenceToCase

  • notifyOnCreateOrReopenCase

  • notifyOnResolveCase

If you don't specify these parameters in your request, they default to false.

notifyOnCreateOrReopenCase
Type: boolean

Whether you want to get notified when a support case is created or reopened.

notifyOnResolveCase
Type: boolean

Whether you want to get notified when a support case is resolved.

teamId
Required: Yes
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:

Your Service Quotas request exceeds the quota for the service. For example, your Service Quotas request to Amazon Web Services Support App might exceed the maximum number of workspaces or channels per account, or the maximum number of accounts per Slack channel.

ConflictException:

Your request has a conflict. For example, you might receive this error if you try the following:

  • Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.

  • Add a Slack channel configuration that already exists in your Amazon Web Services account.

  • Delete a Slack channel configuration for a live chat channel.

  • Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.

  • Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

  • Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

ValidationException:

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

DeleteAccountAlias

$result = $client->deleteAccountAlias([/* ... */]);
$promise = $client->deleteAccountAliasAsync([/* ... */]);

Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Parameter Syntax

$result = $client->deleteAccountAlias([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

DeleteSlackChannelConfiguration

$result = $client->deleteSlackChannelConfiguration([/* ... */]);
$promise = $client->deleteSlackChannelConfigurationAsync([/* ... */]);

Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.

Parameter Syntax

$result = $client->deleteSlackChannelConfiguration([
    'channelId' => '<string>', // REQUIRED
    'teamId' => '<string>', // REQUIRED
]);

Parameter Details

Members
channelId
Required: Yes
Type: string

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

teamId
Required: Yes
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConflictException:

Your request has a conflict. For example, you might receive this error if you try the following:

  • Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.

  • Add a Slack channel configuration that already exists in your Amazon Web Services account.

  • Delete a Slack channel configuration for a live chat channel.

  • Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.

  • Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

  • Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

ResourceNotFoundException:

The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

ValidationException:

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

DeleteSlackWorkspaceConfiguration

$result = $client->deleteSlackWorkspaceConfiguration([/* ... */]);
$promise = $client->deleteSlackWorkspaceConfigurationAsync([/* ... */]);

Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.

Parameter Syntax

$result = $client->deleteSlackWorkspaceConfiguration([
    'teamId' => '<string>', // REQUIRED
]);

Parameter Details

Members
teamId
Required: Yes
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConflictException:

Your request has a conflict. For example, you might receive this error if you try the following:

  • Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.

  • Add a Slack channel configuration that already exists in your Amazon Web Services account.

  • Delete a Slack channel configuration for a live chat channel.

  • Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.

  • Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

  • Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

ResourceNotFoundException:

The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

ValidationException:

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

GetAccountAlias

$result = $client->getAccountAlias([/* ... */]);
$promise = $client->getAccountAliasAsync([/* ... */]);

Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Parameter Syntax

$result = $client->getAccountAlias([
]);

Parameter Details

Members

Result Syntax

[
    'accountAlias' => '<string>',
]

Result Details

Members
accountAlias
Type: string

An alias or short name for an Amazon Web Services account.

Errors

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

ListSlackChannelConfigurations

$result = $client->listSlackChannelConfigurations([/* ... */]);
$promise = $client->listSlackChannelConfigurationsAsync([/* ... */]);

Lists the Slack channel configurations for an Amazon Web Services account.

Parameter Syntax

$result = $client->listSlackChannelConfigurations([
    'nextToken' => '<string>',
]);

Parameter Details

Members
nextToken
Type: string

If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.

Result Syntax

[
    'nextToken' => '<string>',
    'slackChannelConfigurations' => [
        [
            'channelId' => '<string>',
            'channelName' => '<string>',
            'channelRoleArn' => '<string>',
            'notifyOnAddCorrespondenceToCase' => true || false,
            'notifyOnCaseSeverity' => 'none|all|high',
            'notifyOnCreateOrReopenCase' => true || false,
            'notifyOnResolveCase' => true || false,
            'teamId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The point where pagination should resume when the response returns only partial results.

slackChannelConfigurations
Required: Yes
Type: Array of SlackChannelConfiguration structures

The configurations for a Slack channel.

Errors

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

ListSlackWorkspaceConfigurations

$result = $client->listSlackWorkspaceConfigurations([/* ... */]);
$promise = $client->listSlackWorkspaceConfigurationsAsync([/* ... */]);

Lists the Slack workspace configurations for an Amazon Web Services account.

Parameter Syntax

$result = $client->listSlackWorkspaceConfigurations([
    'nextToken' => '<string>',
]);

Parameter Details

Members
nextToken
Type: string

If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.

Result Syntax

[
    'nextToken' => '<string>',
    'slackWorkspaceConfigurations' => [
        [
            'allowOrganizationMemberAccount' => true || false,
            'teamId' => '<string>',
            'teamName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The point where pagination should resume when the response returns only partial results.

slackWorkspaceConfigurations
Type: Array of SlackWorkspaceConfiguration structures

The configurations for a Slack workspace.

Errors

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

PutAccountAlias

$result = $client->putAccountAlias([/* ... */]);
$promise = $client->putAccountAliasAsync([/* ... */]);

Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

Parameter Syntax

$result = $client->putAccountAlias([
    'accountAlias' => '<string>', // REQUIRED
]);

Parameter Details

Members
accountAlias
Required: Yes
Type: string

An alias or short name for an Amazon Web Services account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

ValidationException:

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

RegisterSlackWorkspaceForOrganization

$result = $client->registerSlackWorkspaceForOrganization([/* ... */]);
$promise = $client->registerSlackWorkspaceForOrganizationAsync([/* ... */]);

Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.

If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks:

  1. Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide.

  2. Call the RegisterSlackWorkspaceForOrganization API to authorize each Slack workspace for the organization.

After the management account authorizes the Slack workspace, member accounts can call this API to authorize the same Slack workspace for their individual accounts. Member accounts don't need to authorize the Slack workspace manually through the Amazon Web Services Support Center.

To use the Amazon Web Services Support App, each account must then complete the following tasks:

Parameter Syntax

$result = $client->registerSlackWorkspaceForOrganization([
    'teamId' => '<string>', // REQUIRED
]);

Parameter Details

Members
teamId
Required: Yes
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG. Specify the Slack workspace that you want to use for your organization.

Result Syntax

[
    'accountType' => 'management|member',
    'teamId' => '<string>',
    'teamName' => '<string>',
]

Result Details

Members
accountType
Type: string

Whether the Amazon Web Services account is a management or member account that's part of an organization in Organizations.

teamId
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

teamName
Type: string

The name of the Slack workspace.

Errors

ConflictException:

Your request has a conflict. For example, you might receive this error if you try the following:

  • Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.

  • Add a Slack channel configuration that already exists in your Amazon Web Services account.

  • Delete a Slack channel configuration for a live chat channel.

  • Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.

  • Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

  • Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

ResourceNotFoundException:

The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

ValidationException:

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

UpdateSlackChannelConfiguration

$result = $client->updateSlackChannelConfiguration([/* ... */]);
$promise = $client->updateSlackChannelConfigurationAsync([/* ... */]);

Updates the configuration for a Slack channel, such as case update notifications.

Parameter Syntax

$result = $client->updateSlackChannelConfiguration([
    'channelId' => '<string>', // REQUIRED
    'channelName' => '<string>',
    'channelRoleArn' => '<string>',
    'notifyOnAddCorrespondenceToCase' => true || false,
    'notifyOnCaseSeverity' => 'none|all|high',
    'notifyOnCreateOrReopenCase' => true || false,
    'notifyOnResolveCase' => true || false,
    'teamId' => '<string>', // REQUIRED
]);

Parameter Details

Members
channelId
Required: Yes
Type: string

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

channelName
Type: string

The Slack channel name that you want to update.

channelRoleArn
Type: string

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

notifyOnAddCorrespondenceToCase
Type: boolean

Whether you want to get notified when a support case has a new correspondence.

notifyOnCaseSeverity
Type: string

The case severity for a support case that you want to receive notifications.

If you specify high or all, at least one of the following parameters must be true:

  • notifyOnAddCorrespondenceToCase

  • notifyOnCreateOrReopenCase

  • notifyOnResolveCase

If you specify none, any of the following parameters that you specify in your request must be false:

  • notifyOnAddCorrespondenceToCase

  • notifyOnCreateOrReopenCase

  • notifyOnResolveCase

If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.

notifyOnCreateOrReopenCase
Type: boolean

Whether you want to get notified when a support case is created or reopened.

notifyOnResolveCase
Type: boolean

Whether you want to get notified when a support case is resolved.

teamId
Required: Yes
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

Result Syntax

[
    'channelId' => '<string>',
    'channelName' => '<string>',
    'channelRoleArn' => '<string>',
    'notifyOnAddCorrespondenceToCase' => true || false,
    'notifyOnCaseSeverity' => 'none|all|high',
    'notifyOnCreateOrReopenCase' => true || false,
    'notifyOnResolveCase' => true || false,
    'teamId' => '<string>',
]

Result Details

Members
channelId
Type: string

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

channelName
Type: string

The name of the Slack channel that you configure for the Amazon Web Services Support App.

channelRoleArn
Type: string

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

notifyOnAddCorrespondenceToCase
Type: boolean

Whether you want to get notified when a support case has a new correspondence.

notifyOnCaseSeverity
Type: string

The case severity for a support case that you want to receive notifications.

notifyOnCreateOrReopenCase
Type: boolean

Whether you want to get notified when a support case is created or reopened.

notifyOnResolveCase
Type: boolean

Whether you want to get notified when a support case is resolved.

teamId
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

Errors

ConflictException:

Your request has a conflict. For example, you might receive this error if you try the following:

  • Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.

  • Add a Slack channel configuration that already exists in your Amazon Web Services account.

  • Delete a Slack channel configuration for a live chat channel.

  • Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.

  • Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

  • Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

ResourceNotFoundException:

The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

AccessDeniedException:

You don't have sufficient permission to perform this action.

InternalServerException:

We can’t process your request right now because of a server issue. Try again later.

ValidationException:

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

Shapes

AccessDeniedException

Description

You don't have sufficient permission to perform this action.

Members
message
Type: string

ConflictException

Description

Your request has a conflict. For example, you might receive this error if you try the following:

  • Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.

  • Add a Slack channel configuration that already exists in your Amazon Web Services account.

  • Delete a Slack channel configuration for a live chat channel.

  • Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.

  • Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

  • Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

Members
message
Type: string

InternalServerException

Description

We can’t process your request right now because of a server issue. Try again later.

Members
message
Type: string

ResourceNotFoundException

Description

The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

Members
message
Type: string

ServiceQuotaExceededException

Description

Your Service Quotas request exceeds the quota for the service. For example, your Service Quotas request to Amazon Web Services Support App might exceed the maximum number of workspaces or channels per account, or the maximum number of accounts per Slack channel.

Members
message
Type: string

SlackChannelConfiguration

Description

The configuration for a Slack channel that you added for your Amazon Web Services account.

Members
channelId
Required: Yes
Type: string

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

channelName
Type: string

The name of the Slack channel that you configured with the Amazon Web Services Support App for your Amazon Web Services account.

channelRoleArn
Type: string

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

notifyOnAddCorrespondenceToCase
Type: boolean

Whether you want to get notified when a support case has a new correspondence.

notifyOnCaseSeverity
Type: string

The case severity for a support case that you want to receive notifications.

notifyOnCreateOrReopenCase
Type: boolean

Whether you want to get notified when a support case is created or reopened.

notifyOnResolveCase
Type: boolean

Whether you want to get notified when a support case is resolved.

teamId
Required: Yes
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

SlackWorkspaceConfiguration

Description

The configuration for a Slack workspace that you added to an Amazon Web Services account.

Members
allowOrganizationMemberAccount
Type: boolean

Whether to allow member accounts to authorize Slack workspaces. Member accounts must be part of an organization in Organizations.

teamId
Required: Yes
Type: string

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

teamName
Type: string

The name of the Slack workspace.

ValidationException

Description

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

Members
message
Type: string