We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.SupportApp

Inherits:
AWS.Service show all
Identifier:
supportapp
API Version:
2021-08-20
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can perform the following tasks directly in your Slack channel:

  • Create, search, update, and resolve your support cases

  • Request service quota increases for your account

  • Invite Amazon Web Services Support agents to your channel so that you can chat directly about your support cases

For more information about how to perform these actions in Slack, see the following documentation in the Amazon Web Services Support User Guide:

You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack configurations. For more information, see Authorize a Slack workspace to enable the Amazon Web Services Support App.

Note:
  • You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API.
  • For more information about the Amazon Web Services Support App endpoints, see the Amazon Web Services Support App in Slack endpoints in the Amazon Web Services General Reference.

Sending a Request Using SupportApp

var supportapp = new AWS.SupportApp();
supportapp.createSlackChannelConfiguration(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SupportApp object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var supportapp = new AWS.SupportApp({apiVersion: '2021-08-20'});

You can also set the API version globally in AWS.config.apiVersions using the supportapp service identifier:

AWS.config.apiVersions = {
  supportapp: '2021-08-20',
  // other service API versions
};

var supportapp = new AWS.SupportApp();

Version:

  • 2021-08-20

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SupportApp(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SupportApp object

var supportapp = new AWS.SupportApp({apiVersion: '2021-08-20'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.SupportApp.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.SupportApp.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.SupportApp.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

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

Note:
  • 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.

Note: 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.

Service Reference:

Examples:

Calling the createSlackChannelConfiguration operation

var params = {
  channelId: 'STRING_VALUE', /* required */
  channelRoleArn: 'STRING_VALUE', /* required */
  notifyOnCaseSeverity: none | all | high, /* required */
  teamId: 'STRING_VALUE', /* required */
  channelName: 'STRING_VALUE',
  notifyOnAddCorrespondenceToCase: true || false,
  notifyOnCreateOrReopenCase: true || false,
  notifyOnResolveCase: true || false
};
supportapp.createSlackChannelConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • channelId — (String)

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

    • channelName — (String)

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

    • channelRoleArn — (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 — (Boolean)

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

    • notifyOnCaseSeverity — (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

      Note: If you don't specify these parameters in your request, they default to false.
      Possible values include:
      • "none"
      • "all"
      • "high"
    • notifyOnCreateOrReopenCase — (Boolean)

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

    • notifyOnResolveCase — (Boolean)

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

    • teamId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteAccountAlias(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteAccountAlias operation

var params = {
};
supportapp.deleteAccountAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteSlackChannelConfiguration operation

var params = {
  channelId: 'STRING_VALUE', /* required */
  teamId: 'STRING_VALUE' /* required */
};
supportapp.deleteSlackChannelConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • channelId — (String)

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

    • teamId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSlackWorkspaceConfiguration(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteSlackWorkspaceConfiguration operation

var params = {
  teamId: 'STRING_VALUE' /* required */
};
supportapp.deleteSlackWorkspaceConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • teamId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAccountAlias(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getAccountAlias operation

var params = {
};
supportapp.getAccountAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountAlias — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSlackChannelConfigurations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listSlackChannelConfigurations operation

var params = {
  nextToken: 'STRING_VALUE'
};
supportapp.listSlackChannelConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • slackChannelConfigurations — (Array<map>)

        The configurations for a Slack channel.

        • channelId — required — (String)

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

        • channelName — (String)

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

        • channelRoleArn — (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 — (Boolean)

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

        • notifyOnCaseSeverity — (String)

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

          Possible values include:
          • "none"
          • "all"
          • "high"
        • notifyOnCreateOrReopenCase — (Boolean)

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

        • notifyOnResolveCase — (Boolean)

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

        • teamId — required — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSlackWorkspaceConfigurations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listSlackWorkspaceConfigurations operation

var params = {
  nextToken: 'STRING_VALUE'
};
supportapp.listSlackWorkspaceConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

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

      • slackWorkspaceConfigurations — (Array<map>)

        The configurations for a Slack workspace.

        • allowOrganizationMemberAccount — (Boolean)

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

        • teamId — required — (String)

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

        • teamName — (String)

          The name of the Slack workspace.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putAccountAlias(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putAccountAlias operation

var params = {
  accountAlias: 'STRING_VALUE' /* required */
};
supportapp.putAccountAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountAlias — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

registerSlackWorkspaceForOrganization(params = {}, callback) ⇒ AWS.Request

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:

Service Reference:

Examples:

Calling the registerSlackWorkspaceForOrganization operation

var params = {
  teamId: 'STRING_VALUE' /* required */
};
supportapp.registerSlackWorkspaceForOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • teamId — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountType — (String)

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

        Possible values include:
        • "management"
        • "member"
      • teamId — (String)

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

      • teamName — (String)

        The name of the Slack workspace.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateSlackChannelConfiguration operation

var params = {
  channelId: 'STRING_VALUE', /* required */
  teamId: 'STRING_VALUE', /* required */
  channelName: 'STRING_VALUE',
  channelRoleArn: 'STRING_VALUE',
  notifyOnAddCorrespondenceToCase: true || false,
  notifyOnCaseSeverity: none | all | high,
  notifyOnCreateOrReopenCase: true || false,
  notifyOnResolveCase: true || false
};
supportapp.updateSlackChannelConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • channelId — (String)

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

    • channelName — (String)

      The Slack channel name that you want to update.

    • channelRoleArn — (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 — (Boolean)

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

    • notifyOnCaseSeverity — (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

      Note: If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.
      Possible values include:
      • "none"
      • "all"
      • "high"
    • notifyOnCreateOrReopenCase — (Boolean)

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

    • notifyOnResolveCase — (Boolean)

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

    • teamId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • channelId — (String)

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

      • channelName — (String)

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

      • channelRoleArn — (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 — (Boolean)

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

      • notifyOnCaseSeverity — (String)

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

        Possible values include:
        • "none"
        • "all"
        • "high"
      • notifyOnCreateOrReopenCase — (Boolean)

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

      • notifyOnResolveCase — (Boolean)

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

      • teamId — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.