Client

servicequotas

R Documentation

Service Quotas¶

Description¶

With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your Amazon Web Services account. For more information, see the Service Quotas User Guide.

Usage¶

servicequotas(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

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

credentials:
- creds:
  - 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⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

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

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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.

Service syntax¶

svc <- servicequotas(
  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",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

associate_service_quota_template: Associates your quota request template with your organization; Deletes the quota increase request for the specified quota from your quota request template
disassociate_service_quota_template: Disables your quota request template; Retrieves the status of the association for the quota request template
get_aws_default_service_quota: Retrieves the default value for the specified quota
get_requested_service_quota_change: Retrieves information about the specified quota increase request
get_service_quota: Retrieves the applied quota value for the specified quota; Retrieves information about the specified quota increase request in your quota request template
list_aws_default_service_quotas: Lists the default values for the quotas for the specified Amazon Web Service; Retrieves the quota increase requests for the specified Amazon Web Service; Retrieves the quota increase requests for the specified quota; Lists the quota increase requests in the specified quota request template
list_service_quotas: Lists the applied quota values for the specified Amazon Web Service
list_services: Lists the names and codes for the Amazon Web Services integrated with Service Quotas
list_tags_for_resource: Returns a list of the tags assigned to the specified applied quota; Adds a quota increase request to your quota request template
request_service_quota_increase: Submits a quota increase request for the specified quota
tag_resource: Adds tags to the specified applied quota
untag_resource: Removes tags from the specified applied quota

Examples¶

## Not run: 
svc <- servicequotas()
svc$associate_service_quota_template(
  Foo = 123
)

## End(Not run)