| 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 |
Amazonka.SupportApp
Description
Derived from API version 2021-08-20 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services Support App in Slack
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/:
- Amazon Web Services Support App in Slack
- Joining a live chat session with Amazon Web Services Support
- Requesting service quota increases
- Amazon Web Services Support App commands in Slack
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.
- 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.
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
- data CreateSlackChannelConfiguration = CreateSlackChannelConfiguration' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) Text Text NotificationSeverityLevel Text
- newCreateSlackChannelConfiguration :: Text -> Text -> NotificationSeverityLevel -> Text -> CreateSlackChannelConfiguration
- data CreateSlackChannelConfigurationResponse = CreateSlackChannelConfigurationResponse' Int
- newCreateSlackChannelConfigurationResponse :: Int -> CreateSlackChannelConfigurationResponse
- data DeleteAccountAlias = DeleteAccountAlias' {
- newDeleteAccountAlias :: DeleteAccountAlias
- data DeleteAccountAliasResponse = DeleteAccountAliasResponse' Int
- newDeleteAccountAliasResponse :: Int -> DeleteAccountAliasResponse
- data DeleteSlackChannelConfiguration = DeleteSlackChannelConfiguration' Text Text
- newDeleteSlackChannelConfiguration :: Text -> Text -> DeleteSlackChannelConfiguration
- data DeleteSlackChannelConfigurationResponse = DeleteSlackChannelConfigurationResponse' Int
- newDeleteSlackChannelConfigurationResponse :: Int -> DeleteSlackChannelConfigurationResponse
- data DeleteSlackWorkspaceConfiguration = DeleteSlackWorkspaceConfiguration' Text
- newDeleteSlackWorkspaceConfiguration :: Text -> DeleteSlackWorkspaceConfiguration
- data DeleteSlackWorkspaceConfigurationResponse = DeleteSlackWorkspaceConfigurationResponse' Int
- newDeleteSlackWorkspaceConfigurationResponse :: Int -> DeleteSlackWorkspaceConfigurationResponse
- data GetAccountAlias = GetAccountAlias' {
- newGetAccountAlias :: GetAccountAlias
- data GetAccountAliasResponse = GetAccountAliasResponse' (Maybe Text) Int
- newGetAccountAliasResponse :: Int -> GetAccountAliasResponse
- data ListSlackChannelConfigurations = ListSlackChannelConfigurations' (Maybe Text)
- newListSlackChannelConfigurations :: ListSlackChannelConfigurations
- data ListSlackChannelConfigurationsResponse = ListSlackChannelConfigurationsResponse' (Maybe Text) Int [SlackChannelConfiguration]
- newListSlackChannelConfigurationsResponse :: Int -> ListSlackChannelConfigurationsResponse
- data ListSlackWorkspaceConfigurations = ListSlackWorkspaceConfigurations' (Maybe Text)
- newListSlackWorkspaceConfigurations :: ListSlackWorkspaceConfigurations
- data ListSlackWorkspaceConfigurationsResponse = ListSlackWorkspaceConfigurationsResponse' (Maybe Text) (Maybe [SlackWorkspaceConfiguration]) Int
- newListSlackWorkspaceConfigurationsResponse :: Int -> ListSlackWorkspaceConfigurationsResponse
- data PutAccountAlias = PutAccountAlias' Text
- newPutAccountAlias :: Text -> PutAccountAlias
- data PutAccountAliasResponse = PutAccountAliasResponse' Int
- newPutAccountAliasResponse :: Int -> PutAccountAliasResponse
- data RegisterSlackWorkspaceForOrganization = RegisterSlackWorkspaceForOrganization' Text
- newRegisterSlackWorkspaceForOrganization :: Text -> RegisterSlackWorkspaceForOrganization
- data RegisterSlackWorkspaceForOrganizationResponse = RegisterSlackWorkspaceForOrganizationResponse' (Maybe AccountType) (Maybe Text) (Maybe Text) Int
- newRegisterSlackWorkspaceForOrganizationResponse :: Int -> RegisterSlackWorkspaceForOrganizationResponse
- data UpdateSlackChannelConfiguration = UpdateSlackChannelConfiguration' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NotificationSeverityLevel) (Maybe Bool) (Maybe Bool) Text Text
- newUpdateSlackChannelConfiguration :: Text -> Text -> UpdateSlackChannelConfiguration
- data UpdateSlackChannelConfigurationResponse = UpdateSlackChannelConfigurationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NotificationSeverityLevel) (Maybe Bool) (Maybe Bool) (Maybe Text) Int
- newUpdateSlackChannelConfigurationResponse :: Int -> UpdateSlackChannelConfigurationResponse
- newtype AccountType where
- AccountType' { }
- pattern AccountType_Management :: AccountType
- pattern AccountType_Member :: AccountType
- newtype NotificationSeverityLevel where
- data SlackChannelConfiguration = SlackChannelConfiguration' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NotificationSeverityLevel) (Maybe Bool) (Maybe Bool) Text Text
- newSlackChannelConfiguration :: Text -> Text -> SlackChannelConfiguration
- data SlackWorkspaceConfiguration = SlackWorkspaceConfiguration' (Maybe Bool) (Maybe Text) Text
- newSlackWorkspaceConfiguration :: Text -> SlackWorkspaceConfiguration
Service Configuration
defaultService :: Service Source #
API version 2021-08-20 of the Amazon Support App SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SupportApp.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient permission to perform this action.
ConflictException
_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
RegisterSlackWorkspaceForOrganizationAPI from an Amazon Web Services account that doesn't belong to an organization. - Call the
RegisterSlackWorkspaceForOrganizationAPI from a member account, but the management account hasn't registered that workspace yet for the organization.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
We can’t process your request right now because of a server issue. Try again later.
ResourceNotFoundException
_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
_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
_ValidationException :: AsError a => Fold a ServiceError Source #
Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateSlackChannelConfiguration
data CreateSlackChannelConfiguration Source #
See: newCreateSlackChannelConfiguration smart constructor.
Constructors
| CreateSlackChannelConfiguration' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) Text Text NotificationSeverityLevel Text |
Instances
newCreateSlackChannelConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> NotificationSeverityLevel | |
| -> Text | |
| -> CreateSlackChannelConfiguration |
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.
data CreateSlackChannelConfigurationResponse Source #
See: newCreateSlackChannelConfigurationResponse smart constructor.
Constructors
| CreateSlackChannelConfigurationResponse' Int |
Instances
newCreateSlackChannelConfigurationResponse Source #
Arguments
| :: Int | |
| -> CreateSlackChannelConfigurationResponse |
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.
DeleteAccountAlias
data DeleteAccountAlias Source #
See: newDeleteAccountAlias smart constructor.
Constructors
| DeleteAccountAlias' | |
Instances
newDeleteAccountAlias :: DeleteAccountAlias Source #
Create a value of DeleteAccountAlias with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DeleteAccountAliasResponse Source #
See: newDeleteAccountAliasResponse smart constructor.
Constructors
| DeleteAccountAliasResponse' Int |
Instances
newDeleteAccountAliasResponse Source #
Create a value of DeleteAccountAliasResponse 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:DeleteAccountAliasResponse', deleteAccountAliasResponse_httpStatus - The response's http status code.
DeleteSlackChannelConfiguration
data DeleteSlackChannelConfiguration Source #
See: newDeleteSlackChannelConfiguration smart constructor.
Constructors
| DeleteSlackChannelConfiguration' Text Text |
Instances
newDeleteSlackChannelConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteSlackChannelConfiguration |
Create a value of DeleteSlackChannelConfiguration 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:
DeleteSlackChannelConfiguration, deleteSlackChannelConfiguration_channelId - The channel ID in Slack. This ID identifies a channel within a Slack
workspace.
DeleteSlackChannelConfiguration, deleteSlackChannelConfiguration_teamId - The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as T012ABCDEFG.
data DeleteSlackChannelConfigurationResponse Source #
See: newDeleteSlackChannelConfigurationResponse smart constructor.
Constructors
| DeleteSlackChannelConfigurationResponse' Int |
Instances
newDeleteSlackChannelConfigurationResponse Source #
Arguments
| :: Int | |
| -> DeleteSlackChannelConfigurationResponse |
Create a value of DeleteSlackChannelConfigurationResponse 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:DeleteSlackChannelConfigurationResponse', deleteSlackChannelConfigurationResponse_httpStatus - The response's http status code.
DeleteSlackWorkspaceConfiguration
data DeleteSlackWorkspaceConfiguration Source #
See: newDeleteSlackWorkspaceConfiguration smart constructor.
Constructors
| DeleteSlackWorkspaceConfiguration' Text |
Instances
newDeleteSlackWorkspaceConfiguration Source #
Create a value of DeleteSlackWorkspaceConfiguration 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:
DeleteSlackWorkspaceConfiguration, deleteSlackWorkspaceConfiguration_teamId - The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as T012ABCDEFG.
data DeleteSlackWorkspaceConfigurationResponse Source #
See: newDeleteSlackWorkspaceConfigurationResponse smart constructor.
Constructors
| DeleteSlackWorkspaceConfigurationResponse' Int |
Instances
newDeleteSlackWorkspaceConfigurationResponse Source #
Arguments
| :: Int | |
| -> DeleteSlackWorkspaceConfigurationResponse |
Create a value of DeleteSlackWorkspaceConfigurationResponse 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:DeleteSlackWorkspaceConfigurationResponse', deleteSlackWorkspaceConfigurationResponse_httpStatus - The response's http status code.
GetAccountAlias
data GetAccountAlias Source #
See: newGetAccountAlias smart constructor.
Constructors
| GetAccountAlias' | |
Instances
newGetAccountAlias :: GetAccountAlias Source #
Create a value of GetAccountAlias with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetAccountAliasResponse Source #
See: newGetAccountAliasResponse smart constructor.
Constructors
| GetAccountAliasResponse' (Maybe Text) Int |
Instances
newGetAccountAliasResponse Source #
Create a value of GetAccountAliasResponse 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:accountAlias:GetAccountAliasResponse', getAccountAliasResponse_accountAlias - An alias or short name for an Amazon Web Services account.
$sel:httpStatus:GetAccountAliasResponse', getAccountAliasResponse_httpStatus - The response's http status code.
ListSlackChannelConfigurations
data ListSlackChannelConfigurations Source #
See: newListSlackChannelConfigurations smart constructor.
Constructors
| ListSlackChannelConfigurations' (Maybe Text) |
Instances
newListSlackChannelConfigurations :: ListSlackChannelConfigurations Source #
Create a value of ListSlackChannelConfigurations 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:
ListSlackChannelConfigurations, listSlackChannelConfigurations_nextToken - 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.
data ListSlackChannelConfigurationsResponse Source #
See: newListSlackChannelConfigurationsResponse smart constructor.
Constructors
| ListSlackChannelConfigurationsResponse' (Maybe Text) Int [SlackChannelConfiguration] |
Instances
newListSlackChannelConfigurationsResponse Source #
Arguments
| :: Int | |
| -> ListSlackChannelConfigurationsResponse |
Create a value of ListSlackChannelConfigurationsResponse 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:
ListSlackChannelConfigurations, listSlackChannelConfigurationsResponse_nextToken - The point where pagination should resume when the response returns only
partial results.
$sel:httpStatus:ListSlackChannelConfigurationsResponse', listSlackChannelConfigurationsResponse_httpStatus - The response's http status code.
$sel:slackChannelConfigurations:ListSlackChannelConfigurationsResponse', listSlackChannelConfigurationsResponse_slackChannelConfigurations - The configurations for a Slack channel.
ListSlackWorkspaceConfigurations
data ListSlackWorkspaceConfigurations Source #
See: newListSlackWorkspaceConfigurations smart constructor.
Constructors
| ListSlackWorkspaceConfigurations' (Maybe Text) |
Instances
newListSlackWorkspaceConfigurations :: ListSlackWorkspaceConfigurations Source #
Create a value of ListSlackWorkspaceConfigurations 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:
ListSlackWorkspaceConfigurations, listSlackWorkspaceConfigurations_nextToken - 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.
data ListSlackWorkspaceConfigurationsResponse Source #
See: newListSlackWorkspaceConfigurationsResponse smart constructor.
Constructors
| ListSlackWorkspaceConfigurationsResponse' (Maybe Text) (Maybe [SlackWorkspaceConfiguration]) Int |
Instances
newListSlackWorkspaceConfigurationsResponse Source #
Arguments
| :: Int | |
| -> ListSlackWorkspaceConfigurationsResponse |
Create a value of ListSlackWorkspaceConfigurationsResponse 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:
ListSlackWorkspaceConfigurations, listSlackWorkspaceConfigurationsResponse_nextToken - The point where pagination should resume when the response returns only
partial results.
$sel:slackWorkspaceConfigurations:ListSlackWorkspaceConfigurationsResponse', listSlackWorkspaceConfigurationsResponse_slackWorkspaceConfigurations - The configurations for a Slack workspace.
$sel:httpStatus:ListSlackWorkspaceConfigurationsResponse', listSlackWorkspaceConfigurationsResponse_httpStatus - The response's http status code.
PutAccountAlias
data PutAccountAlias Source #
See: newPutAccountAlias smart constructor.
Constructors
| PutAccountAlias' Text |
Instances
Arguments
| :: Text | |
| -> PutAccountAlias |
Create a value of PutAccountAlias 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:accountAlias:PutAccountAlias', putAccountAlias_accountAlias - An alias or short name for an Amazon Web Services account.
data PutAccountAliasResponse Source #
See: newPutAccountAliasResponse smart constructor.
Constructors
| PutAccountAliasResponse' Int |
Instances
newPutAccountAliasResponse Source #
Create a value of PutAccountAliasResponse 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:PutAccountAliasResponse', putAccountAliasResponse_httpStatus - The response's http status code.
RegisterSlackWorkspaceForOrganization
data RegisterSlackWorkspaceForOrganization Source #
See: newRegisterSlackWorkspaceForOrganization smart constructor.
Constructors
| RegisterSlackWorkspaceForOrganization' Text |
Instances
newRegisterSlackWorkspaceForOrganization Source #
Create a value of RegisterSlackWorkspaceForOrganization 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:
RegisterSlackWorkspaceForOrganization, registerSlackWorkspaceForOrganization_teamId - 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.
data RegisterSlackWorkspaceForOrganizationResponse Source #
See: newRegisterSlackWorkspaceForOrganizationResponse smart constructor.
Constructors
| RegisterSlackWorkspaceForOrganizationResponse' (Maybe AccountType) (Maybe Text) (Maybe Text) Int |
Instances
newRegisterSlackWorkspaceForOrganizationResponse Source #
Arguments
| :: Int |
|
| -> RegisterSlackWorkspaceForOrganizationResponse |
Create a value of RegisterSlackWorkspaceForOrganizationResponse 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:accountType:RegisterSlackWorkspaceForOrganizationResponse', registerSlackWorkspaceForOrganizationResponse_accountType - Whether the Amazon Web Services account is a management or member
account that's part of an organization in Organizations.
RegisterSlackWorkspaceForOrganization, registerSlackWorkspaceForOrganizationResponse_teamId - The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as T012ABCDEFG.
RegisterSlackWorkspaceForOrganizationResponse, registerSlackWorkspaceForOrganizationResponse_teamName - The name of the Slack workspace.
$sel:httpStatus:RegisterSlackWorkspaceForOrganizationResponse', registerSlackWorkspaceForOrganizationResponse_httpStatus - The response's http status code.
UpdateSlackChannelConfiguration
data UpdateSlackChannelConfiguration Source #
See: newUpdateSlackChannelConfiguration smart constructor.
Constructors
| UpdateSlackChannelConfiguration' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NotificationSeverityLevel) (Maybe Bool) (Maybe Bool) Text Text |
Instances
newUpdateSlackChannelConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSlackChannelConfiguration |
Create a value of UpdateSlackChannelConfiguration 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:
UpdateSlackChannelConfiguration, updateSlackChannelConfiguration_channelName - The Slack channel name that you want to update.
UpdateSlackChannelConfiguration, updateSlackChannelConfiguration_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.
UpdateSlackChannelConfiguration, updateSlackChannelConfiguration_notifyOnAddCorrespondenceToCase - Whether you want to get notified when a support case has a new
correspondence.
UpdateSlackChannelConfiguration, updateSlackChannelConfiguration_notifyOnCaseSeverity - 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
If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.
UpdateSlackChannelConfiguration, updateSlackChannelConfiguration_notifyOnCreateOrReopenCase - Whether you want to get notified when a support case is created or
reopened.
UpdateSlackChannelConfiguration, updateSlackChannelConfiguration_notifyOnResolveCase - Whether you want to get notified when a support case is resolved.
UpdateSlackChannelConfiguration, updateSlackChannelConfiguration_channelId - The channel ID in Slack. This ID identifies a channel within a Slack
workspace.
UpdateSlackChannelConfiguration, updateSlackChannelConfiguration_teamId - The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as T012ABCDEFG.
data UpdateSlackChannelConfigurationResponse Source #
See: newUpdateSlackChannelConfigurationResponse smart constructor.
Constructors
| UpdateSlackChannelConfigurationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NotificationSeverityLevel) (Maybe Bool) (Maybe Bool) (Maybe Text) Int |
Instances
newUpdateSlackChannelConfigurationResponse Source #
Arguments
| :: Int | |
| -> UpdateSlackChannelConfigurationResponse |
Create a value of UpdateSlackChannelConfigurationResponse 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:
UpdateSlackChannelConfiguration, updateSlackChannelConfigurationResponse_channelId - The channel ID in Slack. This ID identifies a channel within a Slack
workspace.
UpdateSlackChannelConfiguration, updateSlackChannelConfigurationResponse_channelName - The name of the Slack channel that you configure for the Amazon Web
Services Support App.
UpdateSlackChannelConfiguration, updateSlackChannelConfigurationResponse_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.
UpdateSlackChannelConfiguration, updateSlackChannelConfigurationResponse_notifyOnAddCorrespondenceToCase - Whether you want to get notified when a support case has a new
correspondence.
UpdateSlackChannelConfiguration, updateSlackChannelConfigurationResponse_notifyOnCaseSeverity - The case severity for a support case that you want to receive
notifications.
UpdateSlackChannelConfiguration, updateSlackChannelConfigurationResponse_notifyOnCreateOrReopenCase - Whether you want to get notified when a support case is created or
reopened.
UpdateSlackChannelConfiguration, updateSlackChannelConfigurationResponse_notifyOnResolveCase - Whether you want to get notified when a support case is resolved.
UpdateSlackChannelConfiguration, updateSlackChannelConfigurationResponse_teamId - The team ID in Slack. This ID uniquely identifies a Slack workspace,
such as T012ABCDEFG.
$sel:httpStatus:UpdateSlackChannelConfigurationResponse', updateSlackChannelConfigurationResponse_httpStatus - The response's http status code.
Types
AccountType
newtype AccountType Source #
Constructors
| AccountType' | |
Fields | |
Bundled Patterns
| pattern AccountType_Management :: AccountType | |
| pattern AccountType_Member :: AccountType |
Instances
NotificationSeverityLevel
newtype NotificationSeverityLevel Source #
Constructors
| NotificationSeverityLevel' | |
Fields | |
Bundled Patterns
Instances
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' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NotificationSeverityLevel) (Maybe Bool) (Maybe Bool) Text Text |
Instances
newSlackChannelConfiguration Source #
Arguments
| :: 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.
SlackWorkspaceConfiguration
data SlackWorkspaceConfiguration Source #
The configuration for a Slack workspace that you added to an Amazon Web Services account.
See: newSlackWorkspaceConfiguration smart constructor.
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.