ARCRegionswitch / Client / list_service_quota_warnings

list_service_quota_warnings¶

ARCRegionswitch.Client.list_service_quota_warnings(**kwargs)¶

Lists the service quota warnings for the plans that you can access. Region switch creates a warning when the applied quota value in one Region of a plan is lower than the value required for the matching resource in another Region or account in the plan.

Returns the warnings for the plans that you own and for plans that are shared with your account through AWS Resource Access Manager (AWS RAM). To return warnings for specific plans, provide a list of plan Amazon Resource Names (ARNs). Region switch ignores any plan ARN that you can’t access. If you don’t provide any plan ARNs, Region switch returns the warnings for all of your accessible plans.

Request Syntax

response = client.list_service_quota_warnings(
    planArns=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

planArns (list) –
The Amazon Resource Names (ARNs) of the plans to return service quota warnings for. You can specify up to 100 plan ARNs. Region switch ignores any plan ARN that you can’t access. If you omit this parameter, Region switch returns the warnings for all of your accessible plans.
- (string) –
maxResults (integer) – The maximum number of results to return with this call. Valid values are 1 to 100. If you don’t specify a value, the operation returns up to the maximum number of results.
nextToken (string) – Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'serviceQuotaWarningSummaries': [
        {
            'accountId': 'string',
            'quotaRegion': 'string',
            'serviceCode': 'string',
            'quotaCode': 'string',
            'quotaName': 'string',
            'status': 'pending'|'denied'|'insufficientPermissions'|'maxRegionSwitchRequestsExceeded'|'maxAccountRequestsExceeded',
            'planArn': 'string',
            'requestId': 'string',
            'caseId': 'string',
            'warningMessage': 'string',
            'lastCheckedAt': datetime(2015, 1, 1),
            'warningCreatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- serviceQuotaWarningSummaries (list) –
  
  The service quota warnings for the plans that you can access.
  - (dict) –
    
    A service quota warning for a plan. Region switch creates a warning when the applied quota value in one Region of a plan is lower than the value for the matching resource in another Region or account in the plan, or when it can’t complete a service quota check.
    - accountId (string) –
      
      The Amazon Web Services account ID that owns the plan that the warning applies to.
    - quotaRegion (string) –
      
      The Amazon Web Services Region that the quota applies to.
    - serviceCode (string) –
      
      The service code of the service that the quota belongs to, as defined in Service Quotas. For example, ec2.
    - quotaCode (string) –
      
      The quota code of the quota that the warning applies to, as defined in Service Quotas.
    - quotaName (string) –
      
      The name of the quota that the warning applies to, as defined in Service Quotas.
    - status (string) –
      
      The status of the service quota warning.
    - planArn (string) –
      
      The Amazon Resource Name (ARN) of the plan that the warning applies to.
    - requestId (string) –
      
      The ID of the quota increase request that Region switch submitted, if it submitted one for this quota.
    - caseId (string) –
      
      The ID of the support case associated with the quota increase request, if Region switch submitted one for this quota.
    - warningMessage (string) –
      
      A message that describes the service quota warning.
    - lastCheckedAt (datetime) –
      
      The time (UTC) when Region switch last checked this quota.
    - warningCreatedAt (datetime) –
      
      The time (UTC) when Region switch created this warning.
- nextToken (string) –
  
  A pagination token. A response may contain no results while still including a nextToken. Continue paginating until nextToken is null to retrieve all results.

Exceptions

ARCRegionswitch.Client.exceptions.AccessDeniedException
ARCRegionswitch.Client.exceptions.InternalServerException