| 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.RegisterSlackWorkspaceForOrganization
Description
Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.
If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks:
- Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide.
- Call the
RegisterSlackWorkspaceForOrganizationAPI to authorize each Slack workspace for the organization.
After the management account authorizes the Slack workspace, member accounts can call this API to authorize the same Slack workspace for their individual accounts. Member accounts don't need to authorize the Slack workspace manually through the Amazon Web Services Support Center.
To use the Amazon Web Services Support App, each account must then complete the following tasks:
- Create an Identity and Access Management (IAM) role with the required permission. For more information, see Managing access to the Amazon Web Services Support App.
- Configure a Slack channel to use the Amazon Web Services Support App for support cases for that account. For more information, see Configuring a Slack channel.
Synopsis
- data RegisterSlackWorkspaceForOrganization = RegisterSlackWorkspaceForOrganization' {}
- newRegisterSlackWorkspaceForOrganization :: Text -> RegisterSlackWorkspaceForOrganization
- registerSlackWorkspaceForOrganization_teamId :: Lens' RegisterSlackWorkspaceForOrganization Text
- data RegisterSlackWorkspaceForOrganizationResponse = RegisterSlackWorkspaceForOrganizationResponse' {
- accountType :: Maybe AccountType
- teamId :: Maybe Text
- teamName :: Maybe Text
- httpStatus :: Int
- newRegisterSlackWorkspaceForOrganizationResponse :: Int -> RegisterSlackWorkspaceForOrganizationResponse
- registerSlackWorkspaceForOrganizationResponse_accountType :: Lens' RegisterSlackWorkspaceForOrganizationResponse (Maybe AccountType)
- registerSlackWorkspaceForOrganizationResponse_teamId :: Lens' RegisterSlackWorkspaceForOrganizationResponse (Maybe Text)
- registerSlackWorkspaceForOrganizationResponse_teamName :: Lens' RegisterSlackWorkspaceForOrganizationResponse (Maybe Text)
- registerSlackWorkspaceForOrganizationResponse_httpStatus :: Lens' RegisterSlackWorkspaceForOrganizationResponse Int
Creating a Request
data RegisterSlackWorkspaceForOrganization Source #
See: newRegisterSlackWorkspaceForOrganization smart constructor.
Constructors
| RegisterSlackWorkspaceForOrganization' | |
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.
Request Lenses
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.
Destructuring the Response
data RegisterSlackWorkspaceForOrganizationResponse Source #
See: newRegisterSlackWorkspaceForOrganizationResponse smart constructor.
Constructors
| RegisterSlackWorkspaceForOrganizationResponse' | |
Fields
| |
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.
Response Lenses
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.
registerSlackWorkspaceForOrganizationResponse_teamName :: Lens' RegisterSlackWorkspaceForOrganizationResponse (Maybe Text) Source #
The name of the Slack workspace.
registerSlackWorkspaceForOrganizationResponse_httpStatus :: Lens' RegisterSlackWorkspaceForOrganizationResponse Int Source #
The response's http status code.