CreateSlackChannelConfiguration

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

Creates a Slack channel configuration for your Amazon Web Services 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.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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:

• Create an Identity and Access Management (IAM) role with the required permission. For more information, see Managing access to the Amazon Web Services Support App.

• Configure a Slack channel to use the Amazon Web Services Support App for support cases for that account. For more information, see Configuring a Slack channel.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

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

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.