Class: Aws::Repostspace::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb

Overview

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

client = Aws::Repostspace::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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    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
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: 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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "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.

  • :client_side_monitoring_port (Integer) — default: 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.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 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.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :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

  • :retry_limit (Integer) — default: 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.

  • :retry_max_delay (Integer) — default: 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.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: 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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Repostspace::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Repostspace::EndpointParameters.

  • :http_continue_timeout (Float) — default: 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.

  • :http_idle_timeout (Float) — default: 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.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    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.

  • :ssl_ca_directory (String) —

    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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#batch_add_channel_role_to_accessors(params = {}) ⇒ Types::BatchAddChannelRoleToAccessorsOutput

Add role to multiple users or groups in a private re:Post channel.

Examples:

Example: BatchAddChannelRoleToAccessors


resp = client.batch_add_channel_role_to_accessors({
  accessor_ids: [
    "12345678-1234-1234-1234-1234567890ab", 
  ], 
  channel_id: "WS1234567890abcdefghijkl", 
  channel_role: "MODERATOR", 
  space_id: "SP1234567890abcdefghijkl", 
})

resp.to_h outputs the following:
{
  errors: [
  ], 
  added_accessor_ids: [
    "12345678-1234-1234-1234-1234567890ab", 
  ], 
}

Request syntax with placeholder values


resp = client.batch_add_channel_role_to_accessors({
  space_id: "SpaceId", # required
  channel_id: "ChannelId", # required
  accessor_ids: ["AccessorId"], # required
  channel_role: "ASKER", # required, accepts ASKER, EXPERT, MODERATOR, SUPPORTREQUESTOR
})

Response structure


resp.added_accessor_ids #=> Array
resp.added_accessor_ids[0] #=> String
resp.errors #=> Array
resp.errors[0].accessor_id #=> String
resp.errors[0].error #=> Integer
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :channel_id (required, String) —

    The unique ID of the private re:Post channel.

  • :accessor_ids (required, Array<String>) —

    The user or group identifiers to add the role to.

  • :channel_role (required, String) —

    The channel role to add to the users or groups.

Returns:

See Also:



539
540
541
542
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 539

def batch_add_channel_role_to_accessors(params = {}, options = {})
  req = build_request(:batch_add_channel_role_to_accessors, params)
  req.send_request(options)
end

#batch_add_role(params = {}) ⇒ Types::BatchAddRoleOutput

Add a role to multiple users or groups in a private re:Post.

Examples:

Example: BatchAddRole


resp = client.batch_add_role({
  accessor_ids: [
    "12345678-1234-1234-1234-1234567890ab", 
  ], 
  role: "EXPERT", 
  space_id: "SP1234567890abcdefghijkl", 
})

resp.to_h outputs the following:
{
  errors: [
  ], 
  added_accessor_ids: [
    "12345678-1234-1234-1234-1234567890ab", 
  ], 
}

Request syntax with placeholder values


resp = client.batch_add_role({
  space_id: "SpaceId", # required
  accessor_ids: ["AccessorId"], # required
  role: "EXPERT", # required, accepts EXPERT, MODERATOR, ADMINISTRATOR, SUPPORTREQUESTOR
})

Response structure


resp.added_accessor_ids #=> Array
resp.added_accessor_ids[0] #=> String
resp.errors #=> Array
resp.errors[0].accessor_id #=> String
resp.errors[0].error #=> Integer
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :accessor_ids (required, Array<String>) —

    The user or group accessor identifiers to add the role to.

  • :role (required, String) —

    The role to add to the users or groups.

Returns:

See Also:



601
602
603
604
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 601

def batch_add_role(params = {}, options = {})
  req = build_request(:batch_add_role, params)
  req.send_request(options)
end

#batch_remove_channel_role_from_accessors(params = {}) ⇒ Types::BatchRemoveChannelRoleFromAccessorsOutput

Remove a role from multiple users or groups in a private re:Post channel.

Examples:

Example: BatchRemoveChannelRoleFromAccessors


resp = client.batch_remove_channel_role_from_accessors({
  accessor_ids: [
    "12345678-1234-1234-1234-1234567890ab", 
  ], 
  channel_id: "WS1234567890abcdefghijkl", 
  channel_role: "MODERATOR", 
  space_id: "SP1234567890abcdefghijkl", 
})

resp.to_h outputs the following:
{
  errors: [
  ], 
  removed_accessor_ids: [
    "12345678-1234-1234-1234-1234567890ab", 
  ], 
}

Request syntax with placeholder values


resp = client.batch_remove_channel_role_from_accessors({
  space_id: "SpaceId", # required
  channel_id: "ChannelId", # required
  accessor_ids: ["AccessorId"], # required
  channel_role: "ASKER", # required, accepts ASKER, EXPERT, MODERATOR, SUPPORTREQUESTOR
})

Response structure


resp.removed_accessor_ids #=> Array
resp.removed_accessor_ids[0] #=> String
resp.errors #=> Array
resp.errors[0].accessor_id #=> String
resp.errors[0].error #=> Integer
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :channel_id (required, String) —

    The unique ID of the private re:Post channel.

  • :accessor_ids (required, Array<String>) —

    The users or groups identifiers to remove the role from.

  • :channel_role (required, String) —

    The channel role to remove from the users or groups.

Returns:

See Also:



669
670
671
672
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 669

def batch_remove_channel_role_from_accessors(params = {}, options = {})
  req = build_request(:batch_remove_channel_role_from_accessors, params)
  req.send_request(options)
end

#batch_remove_role(params = {}) ⇒ Types::BatchRemoveRoleOutput

Remove a role from multiple users or groups in a private re:Post.

Examples:

Example: BatchRemoveRole


resp = client.batch_remove_role({
  accessor_ids: [
    "12345678-1234-1234-1234-1234567890ab", 
  ], 
  role: "EXPERT", 
  space_id: "SP1234567890abcdefghijkl", 
})

resp.to_h outputs the following:
{
  errors: [
  ], 
  removed_accessor_ids: [
    "12345678-1234-1234-1234-1234567890ab", 
  ], 
}

Request syntax with placeholder values


resp = client.batch_remove_role({
  space_id: "SpaceId", # required
  accessor_ids: ["AccessorId"], # required
  role: "EXPERT", # required, accepts EXPERT, MODERATOR, ADMINISTRATOR, SUPPORTREQUESTOR
})

Response structure


resp.removed_accessor_ids #=> Array
resp.removed_accessor_ids[0] #=> String
resp.errors #=> Array
resp.errors[0].accessor_id #=> String
resp.errors[0].error #=> Integer
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :accessor_ids (required, Array<String>) —

    The user or group accessor identifiers to remove the role from.

  • :role (required, String) —

    The role to remove from the users or groups.

Returns:

See Also:



731
732
733
734
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 731

def batch_remove_role(params = {}, options = {})
  req = build_request(:batch_remove_role, params)
  req.send_request(options)
end

#create_channel(params = {}) ⇒ Types::CreateChannelOutput

Creates a channel in an AWS re:Post Private private re:Post.

Examples:

Example: CreateChannel


resp = client.create_channel({
  channel_description: "Useful channel description", 
  channel_name: "My First Channel", 
  space_id: "SP1234567890abcdefghijkl", 
})

resp.to_h outputs the following:
{
  channel_id: "WS1234567890abcdefghijkl", 
}

Request syntax with placeholder values


resp = client.create_channel({
  space_id: "SpaceId", # required
  channel_name: "ChannelName", # required
  channel_description: "ChannelDescription",
})

Response structure


resp.channel_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :channel_name (required, String) —

    The name for the channel. This must be unique per private re:Post.

  • :channel_description (String) —

    A description for the channel. This is used only to help you identify this channel.

Returns:

See Also:



782
783
784
785
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 782

def create_channel(params = {}, options = {})
  req = build_request(:create_channel, params)
  req.send_request(options)
end

#create_space(params = {}) ⇒ Types::CreateSpaceOutput

Creates an AWS re:Post Private private re:Post.

Examples:

Request syntax with placeholder values


resp = client.create_space({
  name: "SpaceName", # required
  subdomain: "SpaceSubdomain", # required
  tier: "BASIC", # required, accepts BASIC, STANDARD
  description: "SpaceDescription",
  user_kms_key: "KMSKey",
  tags: {
    "TagKey" => "TagValue",
  },
  role_arn: "Arn",
  supported_email_domains: {
    enabled: "ENABLED", # accepts ENABLED, DISABLED
    allowed_domains: ["EmailDomain"],
  },
})

Response structure


resp.space_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name for the private re:Post. This must be unique in your account.

  • :subdomain (required, String) —

    The subdomain that you use to access your AWS re:Post Private private re:Post. All custom subdomains must be approved by AWS before use. In addition to your custom subdomain, all private re:Posts are issued an AWS generated subdomain for immediate use.

  • :tier (required, String) —

    The pricing tier for the private re:Post.

  • :description (String) —

    A description for the private re:Post. This is used only to help you identify this private re:Post.

  • :user_kms_key (String) —

    The AWS KMS key ARN that’s used for the AWS KMS encryption. If you don't provide a key, your data is encrypted by default with a key that AWS owns and manages for you.

  • :tags (Hash<String,String>) —

    The list of tags associated with the private re:Post.

  • :role_arn (String) —

    The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.

  • :supported_email_domains (Types::SupportedEmailDomainsParameters)

Returns:

See Also:



849
850
851
852
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 849

def create_space(params = {}, options = {})
  req = build_request(:create_space, params)
  req.send_request(options)
end

#delete_space(params = {}) ⇒ Struct

Deletes an AWS re:Post Private private re:Post.

Examples:

Request syntax with placeholder values


resp = client.delete_space({
  space_id: "SpaceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



871
872
873
874
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 871

def delete_space(params = {}, options = {})
  req = build_request(:delete_space, params)
  req.send_request(options)
end

#deregister_admin(params = {}) ⇒ Struct

Removes the user or group from the list of administrators of the private re:Post.

Examples:

Request syntax with placeholder values


resp = client.deregister_admin({
  space_id: "SpaceId", # required
  admin_id: "AdminId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The ID of the private re:Post to remove the admin from.

  • :admin_id (required, String) —

    The ID of the admin to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



898
899
900
901
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 898

def deregister_admin(params = {}, options = {})
  req = build_request(:deregister_admin, params)
  req.send_request(options)
end

#get_channel(params = {}) ⇒ Types::GetChannelOutput

Displays information about a channel in a private re:Post.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • channel_created
  • channel_deleted

Examples:

Example: GetChannel


resp = client.get_channel({
  channel_id: "WS1234567890abcdefghijkl", 
  space_id: "SP1234567890abcdefghijkl", 
})

resp.to_h outputs the following:
{
  channel_description: "Useful channel description", 
  channel_id: "WS1234567890abcdefghijkl", 
  channel_name: "My First Channel", 
  channel_roles: {
    "12345678-1234-1234-1234-1234567890ab" => [
      "ASKER", 
    ], 
  }, 
  channel_status: "CREATED", 
  create_date_time: Time.parse("2025-02-13T18:49:13.713Z"), 
  space_id: "SP1234567890abcdefghijkl", 
}

Request syntax with placeholder values


resp = client.get_channel({
  space_id: "SpaceId", # required
  channel_id: "ChannelId", # required
})

Response structure


resp.space_id #=> String
resp.channel_id #=> String
resp.channel_name #=> String
resp.channel_description #=> String
resp.create_date_time #=> Time
resp.delete_date_time #=> Time
resp.channel_roles #=> Hash
resp.channel_roles["AccessorId"] #=> Array
resp.channel_roles["AccessorId"][0] #=> String, one of "ASKER", "EXPERT", "MODERATOR", "SUPPORTREQUESTOR"
resp.channel_status #=> String, one of "CREATED", "CREATING", "CREATE_FAILED", "DELETED", "DELETING", "DELETE_FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :channel_id (required, String) —

    The unique ID of the private re:Post channel.

Returns:

See Also:



975
976
977
978
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 975

def get_channel(params = {}, options = {})
  req = build_request(:get_channel, params)
  req.send_request(options)
end

#get_space(params = {}) ⇒ Types::GetSpaceOutput

Displays information about the AWS re:Post Private private re:Post.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • space_created
  • space_deleted

Examples:

Request syntax with placeholder values


resp = client.get_space({
  space_id: "SpaceId", # required
})

Response structure


resp.space_id #=> String
resp.arn #=> String
resp.name #=> String
resp.status #=> String
resp.configuration_status #=> String, one of "CONFIGURED", "UNCONFIGURED"
resp.client_id #=> String
resp.identity_store_id #=> String
resp.application_arn #=> String
resp.description #=> String
resp.vanity_domain_status #=> String, one of "PENDING", "APPROVED", "UNAPPROVED"
resp.vanity_domain #=> String
resp.random_domain #=> String
resp.customer_role_arn #=> String
resp.create_date_time #=> Time
resp.delete_date_time #=> Time
resp.tier #=> String, one of "BASIC", "STANDARD"
resp.storage_limit #=> Integer
resp.user_admins #=> Array
resp.user_admins[0] #=> String
resp.group_admins #=> Array
resp.group_admins[0] #=> String
resp.roles #=> Hash
resp.roles["AccessorId"] #=> Array
resp.roles["AccessorId"][0] #=> String, one of "EXPERT", "MODERATOR", "ADMINISTRATOR", "SUPPORTREQUESTOR"
resp.user_kms_key #=> String
resp.user_count #=> Integer
resp.content_size #=> Integer
resp.supported_email_domains.enabled #=> String, one of "ENABLED", "DISABLED", "NOT_ALLOWED"
resp.supported_email_domains.allowed_domains #=> Array
resp.supported_email_domains.allowed_domains[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The ID of the private re:Post.

Returns:

See Also:



1061
1062
1063
1064
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1061

def get_space(params = {}, options = {})
  req = build_request(:get_space, params)
  req.send_request(options)
end

#list_channels(params = {}) ⇒ Types::ListChannelsOutput

Returns the list of channel within a private re:Post with some information about each channel.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: ListChannels


resp = client.list_channels({
  space_id: "SP1234567890abcdefghijkl", 
})

resp.to_h outputs the following:
{
  channels: [
    {
      channel_description: "Useful channel description", 
      channel_id: "WS1234567890abcdefghijkl", 
      channel_name: "My First Channel", 
      channel_status: "CREATED", 
      create_date_time: Time.parse("2020-02-20T20:20:20.420Z"), 
      group_count: 1, 
      space_id: "SP1234567890abcdefghijkl", 
      user_count: 5, 
    }, 
    {
      channel_description: "Better channel description", 
      channel_id: "WSabcdefghijkl1234567890", 
      channel_name: "Better Channel", 
      channel_status: "CREATED", 
      create_date_time: Time.parse("2025-06-20T14:43:34.201Z"), 
      group_count: 0, 
      space_id: "SP1234567890abcdefghijkl", 
      user_count: 1, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_channels({
  space_id: "SpaceId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.channels #=> Array
resp.channels[0].space_id #=> String
resp.channels[0].channel_id #=> String
resp.channels[0].channel_name #=> String
resp.channels[0].channel_description #=> String
resp.channels[0].create_date_time #=> Time
resp.channels[0].delete_date_time #=> Time
resp.channels[0].channel_status #=> String, one of "CREATED", "CREATING", "CREATE_FAILED", "DELETED", "DELETING", "DELETE_FAILED"
resp.channels[0].user_count #=> Integer
resp.channels[0].group_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :next_token (String) —

    The token for the next set of channel to return. You receive this token from a previous ListChannels operation.

  • :max_results (Integer) —

    The maximum number of channels to include in the results.

Returns:

See Also:



1145
1146
1147
1148
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1145

def list_channels(params = {}, options = {})
  req = build_request(:list_channels, params)
  req.send_request(options)
end

#list_spaces(params = {}) ⇒ Types::ListSpacesOutput

Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_spaces({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.spaces #=> Array
resp.spaces[0].space_id #=> String
resp.spaces[0].arn #=> String
resp.spaces[0].name #=> String
resp.spaces[0].description #=> String
resp.spaces[0].status #=> String
resp.spaces[0].configuration_status #=> String, one of "CONFIGURED", "UNCONFIGURED"
resp.spaces[0].vanity_domain_status #=> String, one of "PENDING", "APPROVED", "UNAPPROVED"
resp.spaces[0].vanity_domain #=> String
resp.spaces[0].random_domain #=> String
resp.spaces[0].tier #=> String, one of "BASIC", "STANDARD"
resp.spaces[0].storage_limit #=> Integer
resp.spaces[0].create_date_time #=> Time
resp.spaces[0].delete_date_time #=> Time
resp.spaces[0].user_kms_key #=> String
resp.spaces[0].user_count #=> Integer
resp.spaces[0].content_size #=> Integer
resp.spaces[0].supported_email_domains.enabled #=> String, one of "ENABLED", "DISABLED", "NOT_ALLOWED"
resp.spaces[0].supported_email_domains.allowed_domains #=> Array
resp.spaces[0].supported_email_domains.allowed_domains[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation.

  • :max_results (Integer) —

    The maximum number of private re:Posts to include in the results.

Returns:

See Also:



1202
1203
1204
1205
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1202

def list_spaces(params = {}, options = {})
  req = build_request(:list_spaces, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns the tags that are associated with the AWS re:Post Private resource specified by the resourceArn. The only resource that can be tagged is a private re:Post.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that the tags are associated with.

Returns:

See Also:



1233
1234
1235
1236
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1233

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#register_admin(params = {}) ⇒ Struct

Adds a user or group to the list of administrators of the private re:Post.

Examples:

Request syntax with placeholder values


resp = client.register_admin({
  space_id: "SpaceId", # required
  admin_id: "AdminId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The ID of the private re:Post.

  • :admin_id (required, String) —

    The ID of the administrator.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1260
1261
1262
1263
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1260

def register_admin(params = {}, options = {})
  req = build_request(:register_admin, params)
  req.send_request(options)
end

#send_invites(params = {}) ⇒ Struct

Sends an invitation email to selected users and groups.

Examples:

Request syntax with placeholder values


resp = client.send_invites({
  space_id: "SpaceId", # required
  accessor_ids: ["AccessorId"], # required
  title: "InviteTitle", # required
  body: "InviteBody", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The ID of the private re:Post.

  • :accessor_ids (required, Array<String>) —

    The array of identifiers for the users and groups.

  • :title (required, String) —

    The title of the invite.

  • :body (required, String) —

    The body of the invite.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1294
1295
1296
1297
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1294

def send_invites(params = {}, options = {})
  req = build_request(:send_invites, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Associates tags with an AWS re:Post Private resource. Currently, the only resource that can be tagged is the private re:Post. If you specify a new tag key for the resource, the tag is appended to the list of tags that are associated with the resource. If you specify a tag key that’s already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that the tag is associated with.

  • :tags (required, Hash<String,String>) —

    The list of tag keys and values that must be associated with the resource. You can associate tag keys only, tags (key and values) only, or a combination of tag keys and tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1329
1330
1331
1332
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1329

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the association of the tag with the AWS re:Post Private resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

  • :tag_keys (required, Array<String>) —

    The key values of the tag.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1356
1357
1358
1359
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1356

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_channel(params = {}) ⇒ Struct

Modifies an existing channel.

Examples:

Example: UpdateChannel


resp = client.update_channel({
  channel_description: "Better channel description", 
  channel_id: "WS1234567890abcdefghijkl", 
  channel_name: "Better Channel", 
  space_id: "SP1234567890abcdefghijkl", 
})

Request syntax with placeholder values


resp = client.update_channel({
  space_id: "SpaceId", # required
  channel_id: "ChannelId", # required
  channel_name: "ChannelName", # required
  channel_description: "ChannelDescription",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :channel_id (required, String) —

    The unique ID of the private re:Post channel.

  • :channel_name (required, String) —

    The name for the channel. This must be unique per private re:Post.

  • :channel_description (String) —

    A description for the channel. This is used only to help you identify this channel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1401
1402
1403
1404
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1401

def update_channel(params = {}, options = {})
  req = build_request(:update_channel, params)
  req.send_request(options)
end

#update_space(params = {}) ⇒ Struct

Modifies an existing AWS re:Post Private private re:Post.

Examples:

Request syntax with placeholder values


resp = client.update_space({
  space_id: "SpaceId", # required
  description: "SpaceDescription",
  tier: "BASIC", # accepts BASIC, STANDARD
  role_arn: "Arn",
  supported_email_domains: {
    enabled: "ENABLED", # accepts ENABLED, DISABLED
    allowed_domains: ["EmailDomain"],
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of this private re:Post.

  • :description (String) —

    A description for the private re:Post. This is used only to help you identify this private re:Post.

  • :tier (String) —

    The pricing tier of this private re:Post.

  • :role_arn (String) —

    The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.

  • :supported_email_domains (Types::SupportedEmailDomainsParameters)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1443
1444
1445
1446
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1443

def update_space(params = {}, options = {})
  req = build_request(:update_space, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
channel_created #get_channel 2 60
channel_deleted #get_channel 2 60
space_created #get_space 300 24
space_deleted #get_space 300 24

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



1561
1562
1563
1564
1565
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 1561

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end