class Aws::ChimeSDKIdentity::Client

An API client for ChimeSDKIdentity. To construct a client, you need to configure a `:region` and `:credentials`.

client = Aws::ChimeSDKIdentity::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See {#initialize} for a full list of supported configuration options.

Attributes

identifier[R]

@api private

Public Class Methods

errors_module() click to toggle source

@api private

# File lib/aws-sdk-chimesdkidentity/client.rb, line 956
def errors_module
  Errors
end
new(*args) click to toggle source

@overload initialize(options)

@param [Hash] options
@option options [required, Aws::CredentialProvider] :credentials
  Your AWS credentials. This can be an instance of any one of the
  following classes:

  * `Aws::Credentials` - Used for configuring static, non-refreshing
    credentials.

  * `Aws::SharedCredentials` - Used for loading static credentials from a
    shared file, such as `~/.aws/config`.

  * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.

  * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
    assume a role after providing credentials via the web.

  * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
    access token generated from `aws login`.

  * `Aws::ProcessCredentials` - Used for loading credentials from a
    process that outputs to stdout.

  * `Aws::InstanceProfileCredentials` - Used for loading credentials
    from an EC2 IMDS on an EC2 instance.

  * `Aws::ECSCredentials` - Used for loading credentials from
    instances running in ECS.

  * `Aws::CognitoIdentityCredentials` - Used for loading credentials
    from the Cognito Identity service.

  When `:credentials` are not configured directly, the following
  locations will be searched for credentials:

  * `Aws.config[:credentials]`
  * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
  * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
  * `~/.aws/credentials`
  * `~/.aws/config`
  * EC2/ECS IMDS instance profile - When used by default, the timeouts
    are very aggressive. Construct and pass an instance of
    `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
    enable retries and extended timeouts.

@option options [required, String] :region
  The AWS region to connect to.  The configured `:region` is
  used to determine the service `:endpoint`. When not passed,
  a default `:region` is searched for in the following locations:

  * `Aws.config[:region]`
  * `ENV['AWS_REGION']`
  * `ENV['AMAZON_REGION']`
  * `ENV['AWS_DEFAULT_REGION']`
  * `~/.aws/credentials`
  * `~/.aws/config`

@option options [String] :access_key_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (true)
  Used only in `adaptive` retry mode.  When true, the request will sleep
  until there is sufficent client side capacity to retry the request.
  When false, the request will raise a `RetryCapacityNotAvailableError` and will
  not retry instead of sleeping.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("127.0.0.1")
  Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
  side monitoring agent is running on, where client metrics will be published via UDP.

@option options [Integer] :client_side_monitoring_port (31000)
  Required for publishing client metrics. The port that the client side monitoring
  agent is running on, where client metrics will be published via UDP.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

@option options [String] :endpoint
  The client endpoint is normally constructed from the `:region`
  option. You should only configure an `:endpoint` when connecting
  to test or custom endpoints. This should be a valid HTTP(S) URI.

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (60)
  When :endpoint_discovery and :active_endpoint_cache is enabled,
  Use this option to config the time interval in seconds for making
  requests fetching endpoints information. Defaults to 60 sec.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (3)
  An integer representing the maximum number attempts that will be made for
  a single request, including the initial attempt.  For example,
  setting this value to 5 will result in a request being retried up to
  4 times. Used in `standard` and `adaptive` retry modes.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (:none)
  A delay randomiser function used by the default backoff function.
  Some predefined functions can be referenced by name - :none, :equal, :full,
  otherwise a Proc that takes and returns a number. This option is only used
  in the `legacy` retry mode.

  @see https://www.awsarchitectureblog.com/2015/03/backoff.html

@option options [Integer] :retry_limit (3)
  The maximum number of times to retry failed requests.  Only
  ~ 500 level server errors and certain ~ 400 level client errors
  are retried.  Generally, these are throttling errors, data
  checksum errors, networking errors, timeout errors, auth errors,
  endpoint discovery, and errors from expired credentials.
  This option is only used in the `legacy` retry mode.

@option options [Integer] :retry_max_delay (0)
  The maximum number of seconds to delay between retries (0 for no limit)
  used by the default backoff function. This option is only used in the
  `legacy` retry mode.

@option options [String] :retry_mode ("legacy")
  Specifies which retry algorithm to use. Values are:

  * `legacy` - The pre-existing retry behavior.  This is default value if
    no retry mode is provided.

  * `standard` - A standardized set of retry rules across the AWS SDKs.
    This includes support for retry quotas, which limit the number of
    unsuccessful retries a client can make.

  * `adaptive` - An experimental retry mode that includes all the
    functionality of `standard` mode along with automatic client side
    throttling.  This is a provisional mode that may change behavior
    in the future.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Boolean] :stub_responses (false)
  Causes the client to return stubbed responses. By default
  fake responses are generated and returned. You can specify
  the response data to return or errors to raise by calling
  {ClientStubs#stub_responses}. See {ClientStubs} for more information.

  ** Please note ** When response stubbing is enabled, no HTTP
  requests are made, and retries are disabled.

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [URI::HTTP,String] :http_proxy A proxy to send
  requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_open_timeout (15) The number of
  seconds to wait when opening a HTTP session before raising a
  `Timeout::Error`.

@option options [Integer] :http_read_timeout (60) The default
  number of seconds to wait for response data.  This value can
  safely be set per-request on the session.

@option options [Float] :http_idle_timeout (5) The number of
  seconds a connection is allowed to sit idle before it is
  considered stale.  Stale connections are closed and removed
  from the pool before making a request.

@option options [Float] :http_continue_timeout (1) The number of
  seconds to wait for a 100-continue response before sending the
  request body.  This option has no effect unless the request has
  "Expect" header set to "100-continue".  Defaults to `nil` which
  disables this behaviour.  This value can safely be set per
  request on the session.

@option options [Boolean] :http_wire_trace (false) When `true`,
  HTTP debug output will be sent to the `:logger`.

@option options [Boolean] :ssl_verify_peer (true) When `true`,
  SSL peer certificates are verified when establishing a
  connection.

@option options [String] :ssl_ca_bundle Full path to the SSL
  certificate authority bundle file that should be used when
  verifying peer certificates.  If you do not pass
  `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
  will be used if available.

@option options [String] :ssl_ca_directory Full path of the
  directory that contains the unbundled SSL certificate
  authority files for verifying peer certificates.  If you do
  not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
  system default will be used if available.
Calls superclass method
# File lib/aws-sdk-chimesdkidentity/client.rb, line 324
def initialize(*args)
  super
end

Public Instance Methods

build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-chimesdkidentity/client.rb, line 931
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-chimesdkidentity'
  context[:gem_version] = '1.2.0'
  Seahorse::Client::Request.new(handlers, context)
end
create_app_instance(params = {}, options = {}) click to toggle source

Creates an Amazon Chime SDK messaging `AppInstance` under an AWS account. Only SDK messaging customers use this API. `CreateAppInstance` supports idempotency behavior as described in the AWS API Standard.

identity

@option params [required, String] :name

The name of the `AppInstance`.

@option params [String] :metadata

The metadata of the `AppInstance`. Limited to a 1KB string in UTF-8.

@option params [required, String] :client_request_token

The `ClientRequestToken` of the `AppInstance`.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.**

@option params [Array<Types::Tag>] :tags

Tags assigned to the `AppInstanceUser`.

@return [Types::CreateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateAppInstanceResponse#app_instance_arn #app_instance_arn} => String

@example Request syntax with placeholder values

resp = client.create_app_instance({
  name: "NonEmptyResourceName", # required
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

@example Response structure

resp.app_instance_arn #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstance AWS API Documentation

@overload create_app_instance(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 378
def create_app_instance(params = {}, options = {})
  req = build_request(:create_app_instance, params)
  req.send_request(options)
end
create_app_instance_admin(params = {}, options = {}) click to toggle source

Promotes an `AppInstanceUser` to an `AppInstanceAdmin`. The promoted user can perform the following actions.

  • `ChannelModerator` actions across all channels in the `AppInstance`.

  • `DeleteChannelMessage` actions.

Only an `AppInstanceUser` can be promoted to an `AppInstanceAdmin` role.

@option params [required, String] :app_instance_admin_arn

The ARN of the administrator of the current `AppInstance`.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@return [Types::CreateAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::Identity
* {Types::CreateAppInstanceAdminResponse#app_instance_arn #app_instance_arn} => String

@example Request syntax with placeholder values

resp = client.create_app_instance_admin({
  app_instance_admin_arn: "ChimeArn", # required
  app_instance_arn: "ChimeArn", # required
})

@example Response structure

resp.app_instance_admin.arn #=> String
resp.app_instance_admin.name #=> String
resp.app_instance_arn #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceAdmin AWS API Documentation

@overload create_app_instance_admin(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 421
def create_app_instance_admin(params = {}, options = {})
  req = build_request(:create_app_instance_admin, params)
  req.send_request(options)
end
create_app_instance_user(params = {}, options = {}) click to toggle source

Creates a user under an Amazon Chime `AppInstance`. The request consists of a unique `appInstanceUserId` and `Name` for that user.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance` request.

@option params [required, String] :app_instance_user_id

The user ID of the `AppInstance`.

@option params [required, String] :name

The user's name.

@option params [String] :metadata

The request's metadata. Limited to a 1KB string in UTF-8.

@option params [required, String] :client_request_token

The token assigned to the user requesting an `AppInstance`.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.**

@option params [Array<Types::Tag>] :tags

Tags assigned to the `AppInstanceUser`.

@return [Types::CreateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String

@example Request syntax with placeholder values

resp = client.create_app_instance_user({
  app_instance_arn: "ChimeArn", # required
  app_instance_user_id: "UserId", # required
  name: "UserName", # required
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

@example Response structure

resp.app_instance_user_arn #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceUser AWS API Documentation

@overload create_app_instance_user(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 478
def create_app_instance_user(params = {}, options = {})
  req = build_request(:create_app_instance_user, params)
  req.send_request(options)
end
delete_app_instance(params = {}, options = {}) click to toggle source

Deletes an `AppInstance` and all associated data asynchronously.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.delete_app_instance({
  app_instance_arn: "ChimeArn", # required
})

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstance AWS API Documentation

@overload delete_app_instance(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 500
def delete_app_instance(params = {}, options = {})
  req = build_request(:delete_app_instance, params)
  req.send_request(options)
end
delete_app_instance_admin(params = {}, options = {}) click to toggle source

Demotes an `AppInstanceAdmin` to an `AppInstanceUser`. This action does not delete the user.

@option params [required, String] :app_instance_admin_arn

The ARN of the `AppInstance`'s administrator.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.delete_app_instance_admin({
  app_instance_admin_arn: "ChimeArn", # required
  app_instance_arn: "ChimeArn", # required
})

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceAdmin AWS API Documentation

@overload delete_app_instance_admin(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 527
def delete_app_instance_admin(params = {}, options = {})
  req = build_request(:delete_app_instance_admin, params)
  req.send_request(options)
end
delete_app_instance_user(params = {}, options = {}) click to toggle source

Deletes an `AppInstanceUser`.

@option params [required, String] :app_instance_user_arn

The ARN of the user request being deleted.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.delete_app_instance_user({
  app_instance_user_arn: "ChimeArn", # required
})

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceUser AWS API Documentation

@overload delete_app_instance_user(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 549
def delete_app_instance_user(params = {}, options = {})
  req = build_request(:delete_app_instance_user, params)
  req.send_request(options)
end
describe_app_instance(params = {}, options = {}) click to toggle source

Returns the full details of an `AppInstance`.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@return [Types::DescribeAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeAppInstanceResponse#app_instance #app_instance} => Types::AppInstance

@example Request syntax with placeholder values

resp = client.describe_app_instance({
  app_instance_arn: "ChimeArn", # required
})

@example Response structure

resp.app_instance.app_instance_arn #=> String
resp.app_instance.name #=> String
resp.app_instance.created_timestamp #=> Time
resp.app_instance.last_updated_timestamp #=> Time
resp.app_instance.metadata #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstance AWS API Documentation

@overload describe_app_instance(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 581
def describe_app_instance(params = {}, options = {})
  req = build_request(:describe_app_instance, params)
  req.send_request(options)
end
describe_app_instance_admin(params = {}, options = {}) click to toggle source

Returns the full details of an `AppInstanceAdmin`.

@option params [required, String] :app_instance_admin_arn

The ARN of the `AppInstanceAdmin`.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@return [Types::DescribeAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::AppInstanceAdmin

@example Request syntax with placeholder values

resp = client.describe_app_instance_admin({
  app_instance_admin_arn: "ChimeArn", # required
  app_instance_arn: "ChimeArn", # required
})

@example Response structure

resp.app_instance_admin.admin.arn #=> String
resp.app_instance_admin.admin.name #=> String
resp.app_instance_admin.app_instance_arn #=> String
resp.app_instance_admin.created_timestamp #=> Time

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceAdmin AWS API Documentation

@overload describe_app_instance_admin(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 616
def describe_app_instance_admin(params = {}, options = {})
  req = build_request(:describe_app_instance_admin, params)
  req.send_request(options)
end
describe_app_instance_user(params = {}, options = {}) click to toggle source

Returns the full details of an `AppInstanceUser`.

@option params [required, String] :app_instance_user_arn

The ARN of the `AppInstanceUser`.

@return [Types::DescribeAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeAppInstanceUserResponse#app_instance_user #app_instance_user} => Types::AppInstanceUser

@example Request syntax with placeholder values

resp = client.describe_app_instance_user({
  app_instance_user_arn: "ChimeArn", # required
})

@example Response structure

resp.app_instance_user.app_instance_user_arn #=> String
resp.app_instance_user.name #=> String
resp.app_instance_user.metadata #=> String
resp.app_instance_user.created_timestamp #=> Time
resp.app_instance_user.last_updated_timestamp #=> Time

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceUser AWS API Documentation

@overload describe_app_instance_user(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 648
def describe_app_instance_user(params = {}, options = {})
  req = build_request(:describe_app_instance_user, params)
  req.send_request(options)
end
get_app_instance_retention_settings(params = {}, options = {}) click to toggle source

Gets the retention settings for an `AppInstance`.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@return [Types::GetAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
* {Types::GetAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time

@example Request syntax with placeholder values

resp = client.get_app_instance_retention_settings({
  app_instance_arn: "ChimeArn", # required
})

@example Response structure

resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
resp.initiate_deletion_timestamp #=> Time

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/GetAppInstanceRetentionSettings AWS API Documentation

@overload get_app_instance_retention_settings(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 678
def get_app_instance_retention_settings(params = {}, options = {})
  req = build_request(:get_app_instance_retention_settings, params)
  req.send_request(options)
end
list_app_instance_admins(params = {}, options = {}) click to toggle source

Returns a list of the administrators in the `AppInstance`.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@option params [Integer] :max_results

The maximum number of administrators that you want to return.

@option params [String] :next_token

The token returned from previous API requests until the number of
administrators is reached.

@return [Types::ListAppInstanceAdminsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListAppInstanceAdminsResponse#app_instance_arn #app_instance_arn} => String
* {Types::ListAppInstanceAdminsResponse#app_instance_admins #app_instance_admins} => Array&lt;Types::AppInstanceAdminSummary&gt;
* {Types::ListAppInstanceAdminsResponse#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

resp = client.list_app_instance_admins({
  app_instance_arn: "ChimeArn", # required
  max_results: 1,
  next_token: "NextToken",
})

@example Response structure

resp.app_instance_arn #=> String
resp.app_instance_admins #=> Array
resp.app_instance_admins[0].admin.arn #=> String
resp.app_instance_admins[0].admin.name #=> String
resp.next_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceAdmins AWS API Documentation

@overload list_app_instance_admins(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 723
def list_app_instance_admins(params = {}, options = {})
  req = build_request(:list_app_instance_admins, params)
  req.send_request(options)
end
list_app_instance_users(params = {}, options = {}) click to toggle source

List all `AppInstanceUsers` created under a single `AppInstance`.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@option params [Integer] :max_results

The maximum number of requests that you want returned.

@option params [String] :next_token

The token passed by previous API calls until all requested users are
returned.

@return [Types::ListAppInstanceUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListAppInstanceUsersResponse#app_instance_arn #app_instance_arn} => String
* {Types::ListAppInstanceUsersResponse#app_instance_users #app_instance_users} => Array&lt;Types::AppInstanceUserSummary&gt;
* {Types::ListAppInstanceUsersResponse#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

resp = client.list_app_instance_users({
  app_instance_arn: "ChimeArn", # required
  max_results: 1,
  next_token: "NextToken",
})

@example Response structure

resp.app_instance_arn #=> String
resp.app_instance_users #=> Array
resp.app_instance_users[0].app_instance_user_arn #=> String
resp.app_instance_users[0].name #=> String
resp.app_instance_users[0].metadata #=> String
resp.next_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceUsers AWS API Documentation

@overload list_app_instance_users(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 769
def list_app_instance_users(params = {}, options = {})
  req = build_request(:list_app_instance_users, params)
  req.send_request(options)
end
list_app_instances(params = {}, options = {}) click to toggle source

Lists all Amazon Chime `AppInstance`s created under a single AWS account.

@option params [Integer] :max_results

The maximum number of `AppInstance`s that you want to return.

@option params [String] :next_token

The token passed by previous API requests until you reach the maximum
number of `AppInstances`.

@return [Types::ListAppInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListAppInstancesResponse#app_instances #app_instances} => Array&lt;Types::AppInstanceSummary&gt;
* {Types::ListAppInstancesResponse#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

resp = client.list_app_instances({
  max_results: 1,
  next_token: "NextToken",
})

@example Response structure

resp.app_instances #=> Array
resp.app_instances[0].app_instance_arn #=> String
resp.app_instances[0].name #=> String
resp.app_instances[0].metadata #=> String
resp.next_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstances AWS API Documentation

@overload list_app_instances(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 810
def list_app_instances(params = {}, options = {})
  req = build_request(:list_app_instances, params)
  req.send_request(options)
end
put_app_instance_retention_settings(params = {}, options = {}) click to toggle source

Sets the amount of time in days that a given `AppInstance` retains data.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@option params [required, Types::AppInstanceRetentionSettings] :app_instance_retention_settings

The time in days to retain data. Data type: number.

@return [Types::PutAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::PutAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
* {Types::PutAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time

@example Request syntax with placeholder values

resp = client.put_app_instance_retention_settings({
  app_instance_arn: "ChimeArn", # required
  app_instance_retention_settings: { # required
    channel_retention_settings: {
      retention_days: 1,
    },
  },
})

@example Response structure

resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
resp.initiate_deletion_timestamp #=> Time

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/PutAppInstanceRetentionSettings AWS API Documentation

@overload put_app_instance_retention_settings(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 849
def put_app_instance_retention_settings(params = {}, options = {})
  req = build_request(:put_app_instance_retention_settings, params)
  req.send_request(options)
end
update_app_instance(params = {}, options = {}) click to toggle source

Updates `AppInstance` metadata.

@option params [required, String] :app_instance_arn

The ARN of the `AppInstance`.

@option params [required, String] :name

The name that you want to change.

@option params [required, String] :metadata

The metadata that you want to change.

@return [Types::UpdateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::UpdateAppInstanceResponse#app_instance_arn #app_instance_arn} => String

@example Request syntax with placeholder values

resp = client.update_app_instance({
  app_instance_arn: "ChimeArn", # required
  name: "NonEmptyResourceName", # required
  metadata: "Metadata", # required
})

@example Response structure

resp.app_instance_arn #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstance AWS API Documentation

@overload update_app_instance(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 885
def update_app_instance(params = {}, options = {})
  req = build_request(:update_app_instance, params)
  req.send_request(options)
end
update_app_instance_user(params = {}, options = {}) click to toggle source

Updates the details of an `AppInstanceUser`. You can update names and metadata.

@option params [required, String] :app_instance_user_arn

The ARN of the `AppInstanceUser`.

@option params [required, String] :name

The name of the `AppInstanceUser`.

@option params [required, String] :metadata

The metadata of the `AppInstanceUser`.

@return [Types::UpdateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::UpdateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String

@example Request syntax with placeholder values

resp = client.update_app_instance_user({
  app_instance_user_arn: "ChimeArn", # required
  name: "UserName", # required
  metadata: "Metadata", # required
})

@example Response structure

resp.app_instance_user_arn #=> String

@see docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstanceUser AWS API Documentation

@overload update_app_instance_user(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-chimesdkidentity/client.rb, line 922
def update_app_instance_user(params = {}, options = {})
  req = build_request(:update_app_instance_user, params)
  req.send_request(options)
end
waiter_names() click to toggle source

@api private @deprecated

# File lib/aws-sdk-chimesdkidentity/client.rb, line 946
def waiter_names
  []
end