Class: Aws::CloudControlApi::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
lib/aws-sdk-cloudcontrolapi/client.rb

Overview

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

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` 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:

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

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :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::CloudControlApi::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CloudControlApi::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 ‘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.



478
479
480
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 478

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1384
1385
1386
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 1384

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1387
1388
1389
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 1387

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 1244

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::CloudControlApi')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-cloudcontrolapi'
  context[:gem_version] = '1.54.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_resource_request(params = {}) ⇒ Types::CancelResourceRequestOutput

Cancels the specified resource operation request. For more information, see [Canceling resource operation requests] in the *Amazon Web Services Cloud Control API User Guide*.

Only resource operations requests with a status of ‘PENDING` or `IN_PROGRESS` can be canceled.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-cancel

Examples:

Request syntax with placeholder values


resp = client.cancel_resource_request({
  request_token: "RequestToken", # required
})

Response structure


resp.progress_event.type_name #=> String
resp.progress_event.identifier #=> String
resp.progress_event.request_token #=> String
resp.progress_event.hooks_request_token #=> String
resp.progress_event.operation #=> String, one of "CREATE", "DELETE", "UPDATE"
resp.progress_event.operation_status #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"
resp.progress_event.event_time #=> Time
resp.progress_event.resource_model #=> String
resp.progress_event.status_message #=> String
resp.progress_event.error_code #=> String, one of "NotUpdatable", "InvalidRequest", "AccessDenied", "UnauthorizedTaggingOperation", "InvalidCredentials", "AlreadyExists", "NotFound", "ResourceConflict", "Throttling", "ServiceLimitExceeded", "NotStabilized", "GeneralServiceException", "ServiceInternalError", "ServiceTimeout", "NetworkFailure", "InternalFailure"
resp.progress_event.retry_after #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :request_token (required, String) —

    The ‘RequestToken` of the `ProgressEvent` object returned by the resource operation request.

Returns:

See Also:



527
528
529
530
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 527

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

#create_resource(params = {}) ⇒ Types::CreateResourceOutput

Creates the specified resource. For more information, see [Creating a resource] in the *Amazon Web Services Cloud Control API User Guide*.

After you have initiated a resource creation request, you can monitor the progress of your request by calling [GetResourceRequestStatus] using the ‘RequestToken` of the `ProgressEvent` type returned by `CreateResource`.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html

Examples:

Request syntax with placeholder values


resp = client.create_resource({
  type_name: "TypeName", # required
  type_version_id: "TypeVersionId",
  role_arn: "RoleArn",
  client_token: "ClientToken",
  desired_state: "Properties", # required
})

Response structure


resp.progress_event.type_name #=> String
resp.progress_event.identifier #=> String
resp.progress_event.request_token #=> String
resp.progress_event.hooks_request_token #=> String
resp.progress_event.operation #=> String, one of "CREATE", "DELETE", "UPDATE"
resp.progress_event.operation_status #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"
resp.progress_event.event_time #=> Time
resp.progress_event.resource_model #=> String
resp.progress_event.status_message #=> String
resp.progress_event.error_code #=> String, one of "NotUpdatable", "InvalidRequest", "AccessDenied", "UnauthorizedTaggingOperation", "InvalidCredentials", "AlreadyExists", "NotFound", "ResourceConflict", "Throttling", "ServiceLimitExceeded", "NotStabilized", "GeneralServiceException", "ServiceInternalError", "ServiceTimeout", "NetworkFailure", "InternalFailure"
resp.progress_event.retry_after #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :type_name (required, String) —

    The name of the resource type.

  • :type_version_id (String) —

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the ‘ handlers ` section of the [resource type definition schema].

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see [Specifying credentials] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions

  • :client_token (String) —

    A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

    A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

    If you do not specify a client token, one is generated for inclusion in the request.

    For more information, see [Ensuring resource operation requests are unique] in the *Amazon Web Services Cloud Control API User Guide*.

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

    [1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency

  • :desired_state (required, String) —

    Structured data format representing the desired state of the resource, consisting of that resource’s properties and their desired values.

    <note markdown=“1”> Cloud Control API currently supports JSON as a structured data format.

    </note>

    Specify the desired state as one of the following:

    • A JSON blob

    • A local path containing the desired state in JSON data format

    For more information, see [Composing the desired state of the resource] in the *Amazon Web Services Cloud Control API User Guide*.

    For more information about the properties of a specific resource, refer to the related topic for the resource in the [Resource and property types reference] in the *CloudFormation Users Guide*.

    [1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

See Also:



655
656
657
658
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 655

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

#delete_resource(params = {}) ⇒ Types::DeleteResourceOutput

Deletes the specified resource. For details, see [Deleting a resource] in the *Amazon Web Services Cloud Control API User Guide*.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling [GetResourceRequestStatus] using the ‘RequestToken` of the `ProgressEvent` returned by `DeleteResource`.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-delete.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html

Examples:

Request syntax with placeholder values


resp = client.delete_resource({
  type_name: "TypeName", # required
  type_version_id: "TypeVersionId",
  role_arn: "RoleArn",
  client_token: "ClientToken",
  identifier: "Identifier", # required
})

Response structure


resp.progress_event.type_name #=> String
resp.progress_event.identifier #=> String
resp.progress_event.request_token #=> String
resp.progress_event.hooks_request_token #=> String
resp.progress_event.operation #=> String, one of "CREATE", "DELETE", "UPDATE"
resp.progress_event.operation_status #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"
resp.progress_event.event_time #=> Time
resp.progress_event.resource_model #=> String
resp.progress_event.status_message #=> String
resp.progress_event.error_code #=> String, one of "NotUpdatable", "InvalidRequest", "AccessDenied", "UnauthorizedTaggingOperation", "InvalidCredentials", "AlreadyExists", "NotFound", "ResourceConflict", "Throttling", "ServiceLimitExceeded", "NotStabilized", "GeneralServiceException", "ServiceInternalError", "ServiceTimeout", "NetworkFailure", "InternalFailure"
resp.progress_event.retry_after #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :type_name (required, String) —

    The name of the resource type.

  • :type_version_id (String) —

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the ‘ handlers ` section of the [resource type definition schema].

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see [Specifying credentials] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions

  • :client_token (String) —

    A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

    A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

    If you do not specify a client token, one is generated for inclusion in the request.

    For more information, see [Ensuring resource operation requests are unique] in the *Amazon Web Services Cloud Control API User Guide*.

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

    [1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency

  • :identifier (required, String) —

    The identifier for the resource.

    You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

    For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values *in the order they are specified* in the primary identifier definition, separated by ‘|`.

    For more information, see [Identifying resources] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html

Returns:

See Also:



776
777
778
779
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 776

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

#get_resource(params = {}) ⇒ Types::GetResourceOutput

Returns information about the current state of the specified resource. For details, see [Reading a resource’s current state].

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-read.html

Examples:

Request syntax with placeholder values


resp = client.get_resource({
  type_name: "TypeName", # required
  type_version_id: "TypeVersionId",
  role_arn: "RoleArn",
  identifier: "Identifier", # required
})

Response structure


resp.type_name #=> String
resp.resource_description.identifier #=> String
resp.resource_description.properties #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :type_name (required, String) —

    The name of the resource type.

  • :type_version_id (String) —

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the ‘ handlers ` section of the [resource type definition schema].

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see [Specifying credentials] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions

  • :identifier (required, String) —

    The identifier for the resource.

    You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

    For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values *in the order they are specified* in the primary identifier definition, separated by ‘|`.

    For more information, see [Identifying resources] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html

Returns:

See Also:



863
864
865
866
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 863

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

#get_resource_request_status(params = {}) ⇒ Types::GetResourceRequestStatusOutput

Returns the current status of a resource operation request. For more information, see [Tracking the progress of resource operation requests] in the *Amazon Web Services Cloud Control API User Guide*.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-track

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

* resource_request_success

Examples:

Request syntax with placeholder values


resp = client.get_resource_request_status({
  request_token: "RequestToken", # required
})

Response structure


resp.progress_event.type_name #=> String
resp.progress_event.identifier #=> String
resp.progress_event.request_token #=> String
resp.progress_event.hooks_request_token #=> String
resp.progress_event.operation #=> String, one of "CREATE", "DELETE", "UPDATE"
resp.progress_event.operation_status #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"
resp.progress_event.event_time #=> Time
resp.progress_event.resource_model #=> String
resp.progress_event.status_message #=> String
resp.progress_event.error_code #=> String, one of "NotUpdatable", "InvalidRequest", "AccessDenied", "UnauthorizedTaggingOperation", "InvalidCredentials", "AlreadyExists", "NotFound", "ResourceConflict", "Throttling", "ServiceLimitExceeded", "NotStabilized", "GeneralServiceException", "ServiceInternalError", "ServiceTimeout", "NetworkFailure", "InternalFailure"
resp.progress_event.retry_after #=> Time
resp.hooks_progress_event #=> Array
resp.hooks_progress_event[0].hook_type_name #=> String
resp.hooks_progress_event[0].hook_type_version_id #=> String
resp.hooks_progress_event[0].hook_type_arn #=> String
resp.hooks_progress_event[0].invocation_point #=> String
resp.hooks_progress_event[0].hook_status #=> String
resp.hooks_progress_event[0].hook_event_time #=> Time
resp.hooks_progress_event[0].hook_status_message #=> String
resp.hooks_progress_event[0].failure_mode #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :request_token (required, String) —

    A unique token used to track the progress of the resource operation request.

    Request tokens are included in the ‘ProgressEvent` type returned by a resource operation request.

Returns:

See Also:



927
928
929
930
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 927

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

#list_resource_requests(params = {}) ⇒ Types::ListResourceRequestsOutput

Returns existing resource operation requests. This includes requests of all status types. For more information, see [Listing active resource operation requests] in the *Amazon Web Services Cloud Control API User Guide*.

<note markdown=“1”> Resource operation requests expire after 7 days.

</note>

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-list

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_resource_requests({
  max_results: 1,
  next_token: "NextToken",
  resource_request_status_filter: {
    operations: ["CREATE"], # accepts CREATE, DELETE, UPDATE
    operation_statuses: ["PENDING"], # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED, CANCEL_IN_PROGRESS, CANCEL_COMPLETE
  },
})

Response structure


resp.resource_request_status_summaries #=> Array
resp.resource_request_status_summaries[0].type_name #=> String
resp.resource_request_status_summaries[0].identifier #=> String
resp.resource_request_status_summaries[0].request_token #=> String
resp.resource_request_status_summaries[0].hooks_request_token #=> String
resp.resource_request_status_summaries[0].operation #=> String, one of "CREATE", "DELETE", "UPDATE"
resp.resource_request_status_summaries[0].operation_status #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"
resp.resource_request_status_summaries[0].event_time #=> Time
resp.resource_request_status_summaries[0].resource_model #=> String
resp.resource_request_status_summaries[0].status_message #=> String
resp.resource_request_status_summaries[0].error_code #=> String, one of "NotUpdatable", "InvalidRequest", "AccessDenied", "UnauthorizedTaggingOperation", "InvalidCredentials", "AlreadyExists", "NotFound", "ResourceConflict", "Throttling", "ServiceLimitExceeded", "NotStabilized", "GeneralServiceException", "ServiceInternalError", "ServiceTimeout", "NetworkFailure", "InternalFailure"
resp.resource_request_status_summaries[0].retry_after #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a ‘NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.

    The default is ‘20`.

  • :next_token (String) —

    If the previous paginated request didn’t return all of the remaining results, the response object’s ‘NextToken` parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s ‘NextToken` parameter. If there are no remaining results, the previous response object’s ‘NextToken` parameter is set to `null`.

  • :resource_request_status_filter (Types::ResourceRequestStatusFilter) —

    The filter criteria to apply to the requests returned.

Returns:

See Also:



1002
1003
1004
1005
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 1002

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

#list_resources(params = {}) ⇒ Types::ListResourcesOutput

Returns information about the specified resources. For more information, see [Discovering resources] in the *Amazon Web Services Cloud Control API User Guide*.

You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html

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_resources({
  type_name: "TypeName", # required
  type_version_id: "TypeVersionId",
  role_arn: "RoleArn",
  next_token: "HandlerNextToken",
  max_results: 1,
  resource_model: "Properties",
})

Response structure


resp.type_name #=> String
resp.resource_descriptions #=> Array
resp.resource_descriptions[0].identifier #=> String
resp.resource_descriptions[0].properties #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :type_name (required, String) —

    The name of the resource type.

  • :type_version_id (String) —

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the ‘ handlers ` section of the [resource type definition schema].

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see [Specifying credentials] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions

  • :next_token (String) —

    If the previous paginated request didn’t return all of the remaining results, the response object’s ‘NextToken` parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s ‘NextToken` parameter. If there are no remaining results, the previous response object’s ‘NextToken` parameter is set to `null`.

  • :max_results (Integer) —

    Reserved.

  • :resource_model (String) —

    The resource model to use to select the resources to return.

Returns:

See Also:



1091
1092
1093
1094
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 1091

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

#update_resource(params = {}) ⇒ Types::UpdateResourceOutput

Updates the specified property values in the resource.

You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the [ *RFC 6902 - JavaScript Object Notation (JSON) Patch* ][1] standard.

For details on how Cloud Control API performs resource update operations, see [Updating a resource] in the *Amazon Web Services Cloud Control API User Guide*.

After you have initiated a resource update request, you can monitor the progress of your request by calling [GetResourceRequestStatus] using the ‘RequestToken` of the `ProgressEvent` returned by `UpdateResource`.

For more information about the properties of a specific resource, refer to the related topic for the resource in the [Resource and property types reference] in the *CloudFormation Users Guide*.

[1]: datatracker.ietf.org/doc/html/rfc6902 [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html [3]: docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html [4]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Examples:

Request syntax with placeholder values


resp = client.update_resource({
  type_name: "TypeName", # required
  type_version_id: "TypeVersionId",
  role_arn: "RoleArn",
  client_token: "ClientToken",
  identifier: "Identifier", # required
  patch_document: "PatchDocument", # required
})

Response structure


resp.progress_event.type_name #=> String
resp.progress_event.identifier #=> String
resp.progress_event.request_token #=> String
resp.progress_event.hooks_request_token #=> String
resp.progress_event.operation #=> String, one of "CREATE", "DELETE", "UPDATE"
resp.progress_event.operation_status #=> String, one of "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"
resp.progress_event.event_time #=> Time
resp.progress_event.resource_model #=> String
resp.progress_event.status_message #=> String
resp.progress_event.error_code #=> String, one of "NotUpdatable", "InvalidRequest", "AccessDenied", "UnauthorizedTaggingOperation", "InvalidCredentials", "AlreadyExists", "NotFound", "ResourceConflict", "Throttling", "ServiceLimitExceeded", "NotStabilized", "GeneralServiceException", "ServiceInternalError", "ServiceTimeout", "NetworkFailure", "InternalFailure"
resp.progress_event.retry_after #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :type_name (required, String) —

    The name of the resource type.

  • :type_version_id (String) —

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the ‘ handlers ` section of the [resource type definition schema].

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see [Specifying credentials] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions

  • :client_token (String) —

    A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

    A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

    If you do not specify a client token, one is generated for inclusion in the request.

    For more information, see [Ensuring resource operation requests are unique] in the *Amazon Web Services Cloud Control API User Guide*.

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

    [1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency

  • :identifier (required, String) —

    The identifier for the resource.

    You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

    For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values *in the order they are specified* in the primary identifier definition, separated by ‘|`.

    For more information, see [Identifying resources] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html

  • :patch_document (required, String) —

    A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see [Composing the patch document] in the *Amazon Web Services Cloud Control API User Guide*.

    [1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html#resource-operations-update-patch

Returns:

See Also:



1235
1236
1237
1238
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 1235

def update_resource(params = {}, options = {})
  req = build_request(:update_resource, 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 | | ———————— | ———————————— | ——– | ————- | | resource_request_success | #get_resource_request_status | 5 | 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.



1350
1351
1352
1353
1354
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 1350

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1358
1359
1360
 
# File 'lib/aws-sdk-cloudcontrolapi/client.rb', line 1358

def waiter_names
  waiters.keys
end