Class: Aws::SupportApp::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SupportApp::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb
Overview
An API client for SupportApp. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SupportApp::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_slack_channel_configuration(params = {}) ⇒ Struct
Creates a Slack channel configuration for your Amazon Web Services account.
-
#delete_account_alias(params = {}) ⇒ Struct
Deletes an alias for an Amazon Web Services account ID.
-
#delete_slack_channel_configuration(params = {}) ⇒ Struct
Deletes a Slack channel configuration from your Amazon Web Services account.
-
#delete_slack_workspace_configuration(params = {}) ⇒ Struct
Deletes a Slack workspace configuration from your Amazon Web Services account.
-
#get_account_alias(params = {}) ⇒ Types::GetAccountAliasResult
Retrieves the alias from an Amazon Web Services account ID.
-
#list_slack_channel_configurations(params = {}) ⇒ Types::ListSlackChannelConfigurationsResult
Lists the Slack channel configurations for an Amazon Web Services account.
-
#list_slack_workspace_configurations(params = {}) ⇒ Types::ListSlackWorkspaceConfigurationsResult
Lists the Slack workspace configurations for an Amazon Web Services account.
-
#put_account_alias(params = {}) ⇒ Struct
Creates or updates an individual alias for each Amazon Web Services account ID.
-
#register_slack_workspace_for_organization(params = {}) ⇒ Types::RegisterSlackWorkspaceForOrganizationResult
Registers a Slack workspace for your Amazon Web Services account.
-
#update_slack_channel_configuration(params = {}) ⇒ Types::UpdateSlackChannelConfigurationResult
Updates the configuration for a Slack channel, such as case update notifications.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#create_slack_channel_configuration(params = {}) ⇒ Struct
Creates a Slack channel configuration for your Amazon Web Services account.
- You can add up to 20 Slack channels for your account.
A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel.
531 532 533 534 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 531 def create_slack_channel_configuration(params = {}, = {}) req = build_request(:create_slack_channel_configuration, params) req.send_request() end |
#delete_account_alias(params = {}) ⇒ Struct
Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
547 548 549 550 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 547 def delete_account_alias(params = {}, = {}) req = build_request(:delete_account_alias, params) req.send_request() end |
#delete_slack_channel_configuration(params = {}) ⇒ Struct
Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.
576 577 578 579 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 576 def delete_slack_channel_configuration(params = {}, = {}) req = build_request(:delete_slack_channel_configuration, params) req.send_request() end |
#delete_slack_workspace_configuration(params = {}) ⇒ Struct
Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.
600 601 602 603 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 600 def delete_slack_workspace_configuration(params = {}, = {}) req = build_request(:delete_slack_workspace_configuration, params) req.send_request() end |
#get_account_alias(params = {}) ⇒ Types::GetAccountAliasResult
Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
622 623 624 625 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 622 def get_account_alias(params = {}, = {}) req = build_request(:get_account_alias, params) req.send_request() end |
#list_slack_channel_configurations(params = {}) ⇒ Types::ListSlackChannelConfigurationsResult
Lists the Slack channel configurations for an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
668 669 670 671 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 668 def list_slack_channel_configurations(params = {}, = {}) req = build_request(:list_slack_channel_configurations, params) req.send_request() end |
#list_slack_workspace_configurations(params = {}) ⇒ Types::ListSlackWorkspaceConfigurationsResult
Lists the Slack workspace configurations for an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
709 710 711 712 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 709 def list_slack_workspace_configurations(params = {}, = {}) req = build_request(:list_slack_workspace_configurations, params) req.send_request() end |
#put_account_alias(params = {}) ⇒ Struct
Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
734 735 736 737 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 734 def put_account_alias(params = {}, = {}) req = build_request(:put_account_alias, params) req.send_request() end |
#register_slack_workspace_for_organization(params = {}) ⇒ Types::RegisterSlackWorkspaceForOrganizationResult
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
RegisterSlackWorkspaceForOrganization
API 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.
806 807 808 809 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 806 def register_slack_workspace_for_organization(params = {}, = {}) req = build_request(:register_slack_workspace_for_organization, params) req.send_request() end |
#update_slack_channel_configuration(params = {}) ⇒ Types::UpdateSlackChannelConfigurationResult
Updates the configuration for a Slack channel, such as case update notifications.
912 913 914 915 |
# File 'gems/aws-sdk-supportapp/lib/aws-sdk-supportapp/client.rb', line 912 def update_slack_channel_configuration(params = {}, = {}) req = build_request(:update_slack_channel_configuration, params) req.send_request() end |