paws (version 0.3.0)

cloudcontrolapi: AWS Cloud Control API

Description

For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.

Usage

cloudcontrolapi(config = list())

Value

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

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• access_key_id: AWS access key ID

• secret_access_key: AWS secret access key

• session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.

Service syntax

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

Operations

cancel_resource_request	Cancels the specified resource operation request
create_resource	Creates the specified resource
delete_resource	Deletes the specified resource
get_resource	Returns information about the current state of the specified resource
get_resource_request_status	Returns the current status of a resource operation request
list_resource_requests	Returns existing resource operation requests
list_resources	Returns information about the specified resources
update_resource	Updates the specified property values in the resource

Examples

if (FALSE) {
svc <- cloudcontrolapi()
svc$cancel_resource_request(
  Foo = 123
)
}