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.
You need Amazon Web Services CLI version 2.13.20 or higher to view and manage resource-level quotas such as Instances per domain for Amazon OpenSearch Service.
Usage¶
Arguments¶
-
configOptional 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.
- creds:
- 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
trueto 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
- use_dual_stack: Set this to
trueto use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to theAWS_USE_DUALSTACK_ENDPOINTenvironment variable when unset.
- credentials:
-
credentialsOptional 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.
- creds:
-
endpointOptional shorthand for complete URL to use for the constructed client.
-
regionOptional 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",
use_dual_stack = "logical"
),
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 |
|---|---|
create_support_case |
Creates a Support case for an existing quota increase request |
delete_service_quota_increase_request_from_template |
Deletes the quota increase request for the specified quota from your quota request template |
disassociate_service_quota_template |
Disables your quota request template |
get_association_for_service_quota_template |
Retrieves the status of the association for the quota request template |
get_auto_management_configuration |
Retrieves information about your Service Quotas Automatic Management configuration |
get_aws_default_service_quota |
Retrieves the default value for the specified quota |
get_quota_utilization_report |
Retrieves the quota utilization report for your Amazon Web Services account |
get_requested_service_quota_change |
Retrieves information about the specified quota increase request |
get_service_quota |
Retrieves the applied quota value for the specified account-level or resource-level quota |
get_service_quota_increase_request_from_template |
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 Services service |
list_requested_service_quota_change_history |
Retrieves the quota increase requests for the specified Amazon Web Services service |
list_requested_service_quota_change_history_by_quota |
Retrieves the quota increase requests for the specified quota |
list_service_quota_increase_requests_in_template |
Lists the quota increase requests in the specified quota request template |
list_service_quotas |
Lists the applied quota values for the specified Amazon Web Services service |
list_services |
Lists the names and codes for the Amazon Web Services services integrated with Service Quotas |
list_tags_for_resource |
Returns a list of the tags assigned to the specified applied quota |
put_service_quota_increase_request_into_template |
Adds a quota increase request to your quota request template |
request_service_quota_increase |
Submits a quota increase request for the specified quota at the account or resource level |
start_auto_management |
Starts Service Quotas Automatic Management for an Amazon Web Services account, including notification preferences and excluded quotas configurations |
start_quota_utilization_report |
Initiates the generation of a quota utilization report for your Amazon Web Services account |
stop_auto_management |
Stops Service Quotas Automatic Management for an Amazon Web Services account and removes all associated configurations |
tag_resource |
Adds tags to the specified applied quota |
untag_resource |
Removes tags from the specified applied quota |
update_auto_management |
Updates your Service Quotas Automatic Management configuration, including notification preferences and excluded quotas |