amazonka-support-app-2.0: Amazon Support App SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SupportApp.CreateSlackChannelConfiguration

Description

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.

Synopsis

Creating a Request

data CreateSlackChannelConfiguration Source #

See: newCreateSlackChannelConfiguration smart constructor.

Constructors

CreateSlackChannelConfiguration' 

Fields

  • channelName :: Maybe Text

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

  • notifyOnAddCorrespondenceToCase :: Maybe Bool

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

  • notifyOnCreateOrReopenCase :: Maybe Bool

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

  • notifyOnResolveCase :: Maybe Bool

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

  • channelId :: Text

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

  • channelRoleArn :: Text

    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.

  • notifyOnCaseSeverity :: NotificationSeverityLevel

    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.

  • teamId :: Text

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

Instances

Instances details
ToJSON CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

ToHeaders CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

ToPath CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

ToQuery CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

AWSRequest CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

Generic CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

Associated Types

type Rep CreateSlackChannelConfiguration :: Type -> Type #

Read CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

Show CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

NFData CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

Eq CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

Hashable CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

type AWSResponse CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

type Rep CreateSlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

type Rep CreateSlackChannelConfiguration = D1 ('MetaData "CreateSlackChannelConfiguration" "Amazonka.SupportApp.CreateSlackChannelConfiguration" "amazonka-support-app-2.0-K70l4Z7c1tk36e2ucvecLC" 'False) (C1 ('MetaCons "CreateSlackChannelConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "notifyOnAddCorrespondenceToCase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "notifyOnCreateOrReopenCase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "notifyOnResolveCase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "channelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "channelRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "notifyOnCaseSeverity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NotificationSeverityLevel) :*: S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateSlackChannelConfiguration Source #

Create a value of CreateSlackChannelConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

CreateSlackChannelConfiguration, createSlackChannelConfiguration_notifyOnAddCorrespondenceToCase - Whether you want to get notified when a support case has a new correspondence.

CreateSlackChannelConfiguration, createSlackChannelConfiguration_notifyOnCreateOrReopenCase - Whether you want to get notified when a support case is created or reopened.

CreateSlackChannelConfiguration, createSlackChannelConfiguration_notifyOnResolveCase - Whether you want to get notified when a support case is resolved.

CreateSlackChannelConfiguration, createSlackChannelConfiguration_channelId - The channel ID in Slack. This ID identifies a channel within a Slack workspace.

CreateSlackChannelConfiguration, createSlackChannelConfiguration_channelRoleArn - 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.

CreateSlackChannelConfiguration, createSlackChannelConfiguration_notifyOnCaseSeverity - 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.

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

Request Lenses

createSlackChannelConfiguration_channelName :: Lens' CreateSlackChannelConfiguration (Maybe Text) Source #

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

createSlackChannelConfiguration_notifyOnAddCorrespondenceToCase :: Lens' CreateSlackChannelConfiguration (Maybe Bool) Source #

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

createSlackChannelConfiguration_notifyOnCreateOrReopenCase :: Lens' CreateSlackChannelConfiguration (Maybe Bool) Source #

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

createSlackChannelConfiguration_notifyOnResolveCase :: Lens' CreateSlackChannelConfiguration (Maybe Bool) Source #

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

createSlackChannelConfiguration_channelId :: Lens' CreateSlackChannelConfiguration Text Source #

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

createSlackChannelConfiguration_channelRoleArn :: Lens' CreateSlackChannelConfiguration Text Source #

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.

createSlackChannelConfiguration_notifyOnCaseSeverity :: Lens' CreateSlackChannelConfiguration NotificationSeverityLevel Source #

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.

createSlackChannelConfiguration_teamId :: Lens' CreateSlackChannelConfiguration Text Source #

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

Destructuring the Response

data CreateSlackChannelConfigurationResponse Source #

Constructors

CreateSlackChannelConfigurationResponse' 

Fields

Instances

Instances details
Generic CreateSlackChannelConfigurationResponse Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

Read CreateSlackChannelConfigurationResponse Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

Show CreateSlackChannelConfigurationResponse Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

NFData CreateSlackChannelConfigurationResponse Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

Eq CreateSlackChannelConfigurationResponse Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

type Rep CreateSlackChannelConfigurationResponse Source # 
Instance details

Defined in Amazonka.SupportApp.CreateSlackChannelConfiguration

type Rep CreateSlackChannelConfigurationResponse = D1 ('MetaData "CreateSlackChannelConfigurationResponse" "Amazonka.SupportApp.CreateSlackChannelConfiguration" "amazonka-support-app-2.0-K70l4Z7c1tk36e2ucvecLC" 'False) (C1 ('MetaCons "CreateSlackChannelConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSlackChannelConfigurationResponse Source #

Create a value of CreateSlackChannelConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateSlackChannelConfigurationResponse', createSlackChannelConfigurationResponse_httpStatus - The response's http status code.

Response Lenses