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.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2021-08-20 of the Amazon Support App SDK configuration.

Errors

_AccessDeniedException :: AsError a => Fold a ServiceError Source #

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

_ConflictException :: AsError a => Fold a ServiceError Source #

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.

_InternalServerException :: AsError a => Fold a ServiceError Source #

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

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

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

_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #

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.

_ValidationException :: AsError a => Fold a ServiceError Source #

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

AccountType

newtype AccountType Source #

Constructors

AccountType' 

Bundled Patterns

pattern AccountType_Management :: AccountType 
pattern AccountType_Member :: AccountType 

Instances

Instances details
FromJSON AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

FromJSONKey AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

ToJSON AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

ToJSONKey AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

ToByteString AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

ToHeader AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

ToLog AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

ToQuery AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

FromText AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

ToText AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

Methods

toText :: AccountType -> Text #

FromXML AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

ToXML AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

Methods

toXML :: AccountType -> XML #

Generic AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

Associated Types

type Rep AccountType :: Type -> Type #

Read AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

Show AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

NFData AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

Methods

rnf :: AccountType -> () #

Eq AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

Ord AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

Hashable AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

type Rep AccountType Source # 
Instance details

Defined in Amazonka.SupportApp.Types.AccountType

type Rep AccountType = D1 ('MetaData "AccountType" "Amazonka.SupportApp.Types.AccountType" "amazonka-support-app-2.0-K70l4Z7c1tk36e2ucvecLC" 'True) (C1 ('MetaCons "AccountType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAccountType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

NotificationSeverityLevel

newtype NotificationSeverityLevel Source #

Instances

Instances details
FromJSON NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

FromJSONKey NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

ToJSON NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

ToJSONKey NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

ToByteString NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

ToHeader NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

ToLog NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

ToQuery NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

FromText NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

ToText NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

FromXML NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

ToXML NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

Generic NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

Associated Types

type Rep NotificationSeverityLevel :: Type -> Type #

Read NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

Show NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

NFData NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

Eq NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

Ord NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

Hashable NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

type Rep NotificationSeverityLevel Source # 
Instance details

Defined in Amazonka.SupportApp.Types.NotificationSeverityLevel

type Rep NotificationSeverityLevel = D1 ('MetaData "NotificationSeverityLevel" "Amazonka.SupportApp.Types.NotificationSeverityLevel" "amazonka-support-app-2.0-K70l4Z7c1tk36e2ucvecLC" 'True) (C1 ('MetaCons "NotificationSeverityLevel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromNotificationSeverityLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SlackChannelConfiguration

data SlackChannelConfiguration Source #

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

See: newSlackChannelConfiguration smart constructor.

Constructors

SlackChannelConfiguration' 

Fields

Instances

Instances details
FromJSON SlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackChannelConfiguration

Generic SlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackChannelConfiguration

Associated Types

type Rep SlackChannelConfiguration :: Type -> Type #

Read SlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackChannelConfiguration

Show SlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackChannelConfiguration

NFData SlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackChannelConfiguration

Eq SlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackChannelConfiguration

Hashable SlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackChannelConfiguration

type Rep SlackChannelConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackChannelConfiguration

type Rep SlackChannelConfiguration = D1 ('MetaData "SlackChannelConfiguration" "Amazonka.SupportApp.Types.SlackChannelConfiguration" "amazonka-support-app-2.0-K70l4Z7c1tk36e2ucvecLC" 'False) (C1 ('MetaCons "SlackChannelConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "notifyOnAddCorrespondenceToCase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "notifyOnCaseSeverity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationSeverityLevel)))) :*: ((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 "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSlackChannelConfiguration Source #

Create a value of SlackChannelConfiguration 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:channelName:SlackChannelConfiguration', slackChannelConfiguration_channelName - The name of the Slack channel that you configured with the Amazon Web Services Support App for your Amazon Web Services account.

$sel:channelRoleArn:SlackChannelConfiguration', slackChannelConfiguration_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.

$sel:notifyOnAddCorrespondenceToCase:SlackChannelConfiguration', slackChannelConfiguration_notifyOnAddCorrespondenceToCase - Whether you want to get notified when a support case has a new correspondence.

$sel:notifyOnCaseSeverity:SlackChannelConfiguration', slackChannelConfiguration_notifyOnCaseSeverity - The case severity for a support case that you want to receive notifications.

$sel:notifyOnCreateOrReopenCase:SlackChannelConfiguration', slackChannelConfiguration_notifyOnCreateOrReopenCase - Whether you want to get notified when a support case is created or reopened.

$sel:notifyOnResolveCase:SlackChannelConfiguration', slackChannelConfiguration_notifyOnResolveCase - Whether you want to get notified when a support case is resolved.

$sel:channelId:SlackChannelConfiguration', slackChannelConfiguration_channelId - The channel ID in Slack. This ID identifies a channel within a Slack workspace.

$sel:teamId:SlackChannelConfiguration', slackChannelConfiguration_teamId - The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

slackChannelConfiguration_channelName :: Lens' SlackChannelConfiguration (Maybe Text) Source #

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

slackChannelConfiguration_channelRoleArn :: Lens' SlackChannelConfiguration (Maybe 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.

slackChannelConfiguration_notifyOnAddCorrespondenceToCase :: Lens' SlackChannelConfiguration (Maybe Bool) Source #

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

slackChannelConfiguration_notifyOnCaseSeverity :: Lens' SlackChannelConfiguration (Maybe NotificationSeverityLevel) Source #

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

slackChannelConfiguration_notifyOnCreateOrReopenCase :: Lens' SlackChannelConfiguration (Maybe Bool) Source #

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

slackChannelConfiguration_notifyOnResolveCase :: Lens' SlackChannelConfiguration (Maybe Bool) Source #

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

slackChannelConfiguration_channelId :: Lens' SlackChannelConfiguration Text Source #

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

slackChannelConfiguration_teamId :: Lens' SlackChannelConfiguration Text Source #

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

SlackWorkspaceConfiguration

data SlackWorkspaceConfiguration Source #

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

See: newSlackWorkspaceConfiguration smart constructor.

Constructors

SlackWorkspaceConfiguration' 

Fields

  • allowOrganizationMemberAccount :: Maybe Bool

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

  • teamName :: Maybe Text

    The name of the Slack workspace.

  • teamId :: Text

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

Instances

Instances details
FromJSON SlackWorkspaceConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackWorkspaceConfiguration

Generic SlackWorkspaceConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackWorkspaceConfiguration

Associated Types

type Rep SlackWorkspaceConfiguration :: Type -> Type #

Read SlackWorkspaceConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackWorkspaceConfiguration

Show SlackWorkspaceConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackWorkspaceConfiguration

NFData SlackWorkspaceConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackWorkspaceConfiguration

Eq SlackWorkspaceConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackWorkspaceConfiguration

Hashable SlackWorkspaceConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackWorkspaceConfiguration

type Rep SlackWorkspaceConfiguration Source # 
Instance details

Defined in Amazonka.SupportApp.Types.SlackWorkspaceConfiguration

type Rep SlackWorkspaceConfiguration = D1 ('MetaData "SlackWorkspaceConfiguration" "Amazonka.SupportApp.Types.SlackWorkspaceConfiguration" "amazonka-support-app-2.0-K70l4Z7c1tk36e2ucvecLC" 'False) (C1 ('MetaCons "SlackWorkspaceConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowOrganizationMemberAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "teamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSlackWorkspaceConfiguration Source #

Create a value of SlackWorkspaceConfiguration 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:allowOrganizationMemberAccount:SlackWorkspaceConfiguration', slackWorkspaceConfiguration_allowOrganizationMemberAccount - Whether to allow member accounts to authorize Slack workspaces. Member accounts must be part of an organization in Organizations.

$sel:teamName:SlackWorkspaceConfiguration', slackWorkspaceConfiguration_teamName - The name of the Slack workspace.

$sel:teamId:SlackWorkspaceConfiguration', slackWorkspaceConfiguration_teamId - The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

slackWorkspaceConfiguration_allowOrganizationMemberAccount :: Lens' SlackWorkspaceConfiguration (Maybe Bool) Source #

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

slackWorkspaceConfiguration_teamId :: Lens' SlackWorkspaceConfiguration Text Source #

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