supportapp: AWS Support App

In paws: Amazon Web Services Software Development Kit

AWS Support App

Description

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.

Usage

supportapp(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- supportapp(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_slack_channel_configuration	Creates a Slack channel configuration for your Amazon Web Services account
delete_account_alias	Deletes an alias for an Amazon Web Services account ID
delete_slack_channel_configuration	Deletes a Slack channel configuration from your Amazon Web Services account
delete_slack_workspace_configuration	Deletes a Slack workspace configuration from your Amazon Web Services account
get_account_alias	Retrieves the alias from an Amazon Web Services account ID
list_slack_channel_configurations	Lists the Slack channel configurations for an Amazon Web Services account
list_slack_workspace_configurations	Lists the Slack workspace configurations for an Amazon Web Services account
put_account_alias	Creates or updates an individual alias for each Amazon Web Services account ID
register_slack_workspace_for_organization	Registers a Slack workspace for your Amazon Web Services account
update_slack_channel_configuration	Updates the configuration for a Slack channel, such as case update notifications

Examples

## Not run: 
svc <- supportapp()
svc$create_slack_channel_configuration(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.