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):

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

    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. 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)
  • :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.

  • :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 —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :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_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.

  • :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 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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an 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_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.



409
410
411
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 409

def initialize(*args)
  super
end

Instance Method Details

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.space_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

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

  • :name (required, String) —

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

  • :role_arn (String) —

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

  • :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.

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

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

  • :tier (required, String) —

    The pricing tier for the 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.

Returns:

See Also:



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

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:



493
494
495
496
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 493

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({
  admin_id: "AdminId", # required
  space_id: "SpaceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :admin_id (required, String) —

    The ID of the admin to remove.

  • :space_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



520
521
522
523
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 520

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.client_id #=> String
resp.configuration_status #=> String, one of "CONFIGURED", "UNCONFIGURED"
resp.content_size #=> Integer
resp.create_date_time #=> Time
resp.customer_role_arn #=> String
resp.delete_date_time #=> Time
resp.description #=> String
resp.group_admins #=> Array
resp.group_admins[0] #=> String
resp.name #=> String
resp.random_domain #=> String
resp.space_id #=> String
resp.status #=> String
resp.storage_limit #=> Integer
resp.tier #=> String, one of "BASIC", "STANDARD"
resp.user_admins #=> Array
resp.user_admins[0] #=> String
resp.user_count #=> Integer
resp.user_kms_key #=> String
resp.vanity_domain #=> String
resp.vanity_domain_status #=> String, one of "PENDING", "APPROVED", "UNAPPROVED"

Parameters:

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

    ({})

Options Hash (params):

  • :space_id (required, String) —

    The ID of the private re:Post.

Returns:

See Also:



588
589
590
591
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 588

def get_space(params = {}, options = {})
  req = build_request(:get_space, 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({
  max_results: 1,
  next_token: "String",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



642
643
644
645
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 642

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:



673
674
675
676
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 673

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({
  admin_id: "AdminId", # required
  space_id: "SpaceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :admin_id (required, String) —

    The ID of the administrator.

  • :space_id (required, String) —

    The ID of the private re:Post.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



700
701
702
703
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 700

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({
  accessor_ids: ["AccessorId"], # required
  body: "InviteBody", # required
  space_id: "SpaceId", # required
  title: "InviteTitle", # required
})

Parameters:

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

    ({})

Options Hash (params):

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

    The array of identifiers for the users and groups.

  • :body (required, String) —

    The body of the invite.

  • :space_id (required, String) —

    The ID of the private re:Post.

  • :title (required, String) —

    The title of the invite.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



734
735
736
737
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 734

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:



769
770
771
772
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 769

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:



796
797
798
799
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 796

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, 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({
  description: "SpaceDescription",
  role_arn: "Arn",
  space_id: "SpaceId", # required
  tier: "BASIC", # accepts BASIC, STANDARD
})

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    A description for the private re:Post. This is used only to help you identify 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.

  • :space_id (required, String) —

    The unique ID of this private re:Post.

  • :tier (String) —

    The pricing tier of this private re:Post.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



832
833
834
835
 
# File 'gems/aws-sdk-repostspace/lib/aws-sdk-repostspace/client.rb', line 832

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