Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype AccountType where
- AccountType' { }
- pattern AccountType_Management :: AccountType
- pattern AccountType_Member :: AccountType
- newtype NotificationSeverityLevel where
- data SlackChannelConfiguration = SlackChannelConfiguration' {}
- newSlackChannelConfiguration :: Text -> Text -> SlackChannelConfiguration
- slackChannelConfiguration_channelName :: Lens' SlackChannelConfiguration (Maybe Text)
- slackChannelConfiguration_channelRoleArn :: Lens' SlackChannelConfiguration (Maybe Text)
- slackChannelConfiguration_notifyOnAddCorrespondenceToCase :: Lens' SlackChannelConfiguration (Maybe Bool)
- slackChannelConfiguration_notifyOnCaseSeverity :: Lens' SlackChannelConfiguration (Maybe NotificationSeverityLevel)
- slackChannelConfiguration_notifyOnCreateOrReopenCase :: Lens' SlackChannelConfiguration (Maybe Bool)
- slackChannelConfiguration_notifyOnResolveCase :: Lens' SlackChannelConfiguration (Maybe Bool)
- slackChannelConfiguration_channelId :: Lens' SlackChannelConfiguration Text
- slackChannelConfiguration_teamId :: Lens' SlackChannelConfiguration Text
- data SlackWorkspaceConfiguration = SlackWorkspaceConfiguration' {}
- newSlackWorkspaceConfiguration :: Text -> SlackWorkspaceConfiguration
- slackWorkspaceConfiguration_allowOrganizationMemberAccount :: Lens' SlackWorkspaceConfiguration (Maybe Bool)
- slackWorkspaceConfiguration_teamName :: Lens' SlackWorkspaceConfiguration (Maybe Text)
- slackWorkspaceConfiguration_teamId :: Lens' SlackWorkspaceConfiguration Text
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 #
pattern AccountType_Management :: AccountType | |
pattern AccountType_Member :: AccountType |
Instances
NotificationSeverityLevel
newtype NotificationSeverityLevel Source #
Instances
SlackChannelConfiguration
data SlackChannelConfiguration Source #
The configuration for a Slack channel that you added for your Amazon Web Services account.
See: newSlackChannelConfiguration
smart constructor.
SlackChannelConfiguration' | |
|
Instances
newSlackChannelConfiguration Source #
:: Text | |
-> Text | |
-> SlackChannelConfiguration |
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.
SlackWorkspaceConfiguration' | |
|
Instances
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_teamName :: Lens' SlackWorkspaceConfiguration (Maybe Text) Source #
The name of the Slack workspace.
slackWorkspaceConfiguration_teamId :: Lens' SlackWorkspaceConfiguration Text Source #
The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as T012ABCDEFG
.