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

Description

 
Synopsis

Operations

CreateSlackChannelConfiguration

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.

DeleteAccountAlias

DeleteSlackChannelConfiguration

deleteSlackChannelConfiguration_channelId :: Lens' DeleteSlackChannelConfiguration Text Source #

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

deleteSlackChannelConfiguration_teamId :: Lens' DeleteSlackChannelConfiguration Text Source #

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

DeleteSlackWorkspaceConfiguration

deleteSlackWorkspaceConfiguration_teamId :: Lens' DeleteSlackWorkspaceConfiguration Text Source #

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

GetAccountAlias

getAccountAliasResponse_accountAlias :: Lens' GetAccountAliasResponse (Maybe Text) Source #

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

ListSlackChannelConfigurations

listSlackChannelConfigurations_nextToken :: Lens' ListSlackChannelConfigurations (Maybe Text) Source #

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.

listSlackChannelConfigurationsResponse_nextToken :: Lens' ListSlackChannelConfigurationsResponse (Maybe Text) Source #

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

ListSlackWorkspaceConfigurations

listSlackWorkspaceConfigurations_nextToken :: Lens' ListSlackWorkspaceConfigurations (Maybe Text) Source #

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.

listSlackWorkspaceConfigurationsResponse_nextToken :: Lens' ListSlackWorkspaceConfigurationsResponse (Maybe Text) Source #

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

PutAccountAlias

putAccountAlias_accountAlias :: Lens' PutAccountAlias Text Source #

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

RegisterSlackWorkspaceForOrganization

registerSlackWorkspaceForOrganization_teamId :: Lens' RegisterSlackWorkspaceForOrganization Text Source #

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.

registerSlackWorkspaceForOrganizationResponse_accountType :: Lens' RegisterSlackWorkspaceForOrganizationResponse (Maybe AccountType) Source #

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

registerSlackWorkspaceForOrganizationResponse_teamId :: Lens' RegisterSlackWorkspaceForOrganizationResponse (Maybe Text) Source #

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

UpdateSlackChannelConfiguration

updateSlackChannelConfiguration_channelRoleArn :: Lens' UpdateSlackChannelConfiguration (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.

updateSlackChannelConfiguration_notifyOnAddCorrespondenceToCase :: Lens' UpdateSlackChannelConfiguration (Maybe Bool) Source #

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

updateSlackChannelConfiguration_notifyOnCaseSeverity :: Lens' UpdateSlackChannelConfiguration (Maybe NotificationSeverityLevel) Source #

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_notifyOnCreateOrReopenCase :: Lens' UpdateSlackChannelConfiguration (Maybe Bool) Source #

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

updateSlackChannelConfiguration_notifyOnResolveCase :: Lens' UpdateSlackChannelConfiguration (Maybe Bool) Source #

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

updateSlackChannelConfiguration_channelId :: Lens' UpdateSlackChannelConfiguration Text Source #

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

updateSlackChannelConfiguration_teamId :: Lens' UpdateSlackChannelConfiguration Text Source #

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

updateSlackChannelConfigurationResponse_channelId :: Lens' UpdateSlackChannelConfigurationResponse (Maybe Text) Source #

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

updateSlackChannelConfigurationResponse_channelName :: Lens' UpdateSlackChannelConfigurationResponse (Maybe Text) Source #

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

updateSlackChannelConfigurationResponse_channelRoleArn :: Lens' UpdateSlackChannelConfigurationResponse (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.

updateSlackChannelConfigurationResponse_notifyOnAddCorrespondenceToCase :: Lens' UpdateSlackChannelConfigurationResponse (Maybe Bool) Source #

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

updateSlackChannelConfigurationResponse_notifyOnCreateOrReopenCase :: Lens' UpdateSlackChannelConfigurationResponse (Maybe Bool) Source #

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

updateSlackChannelConfigurationResponse_teamId :: Lens' UpdateSlackChannelConfigurationResponse (Maybe Text) Source #

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

Types

SlackChannelConfiguration

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

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.