AWS.Tools.ServiceQuotas.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ServiceQuotas</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQAssociationForServiceQuotaTemplateCmdlet"> <summary> Retrieves the <code>ServiceQuotaTemplateAssociationStatus</code> value from the service. Use this action to determine if the Service Quota template is associated, or enabled. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQAWSDefaultServiceQuotaCmdlet"> <summary> Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased.. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQAWSDefaultServiceQuotaCmdlet.QuotaCode"> <summary> <para> <para>Identifies the service quota you want to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQAWSDefaultServiceQuotaCmdlet.ServiceCode"> <summary> <para> <para>Specifies the service that you want to use.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQAWSDefaultServiceQuotaListCmdlet"> <summary> Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to <a>ListServiceQuotas</a> except for the Value object. The Value object returned by <code>ListAWSDefaultServiceQuotas</code> is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you'll see the default values are the values that AWS provides for the quotas. <note><para> Always check the <code>NextToken</code> response parameter when calling any of the <code>List*</code> operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the <code>NextToken</code> response parameter contains a value to pass the next call to the same API to request the next part of the list. </para></note><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQAWSDefaultServiceQuotaListCmdlet.ServiceCode"> <summary> <para> <para>Specifies the service that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQAWSDefaultServiceQuotaListCmdlet.MaxResult"> <summary> <para> <para>(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the <code>NextToken</code> element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the call to the operation to get the next part of the results. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQAWSDefaultServiceQuotaListCmdlet.NextToken"> <summary> <para> <para>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. If additional items exist beyond the specified maximum, the <code>NextToken</code> element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the call to the operation to get the next part of the results. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeCmdlet"> <summary> Retrieves the details for a particular increase request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeCmdlet.RequestId"> <summary> <para> <para>Identifies the quota increase request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryByQuotaListCmdlet"> <summary> Requests a list of the changes to specific service quotas. This command provides additional granularity over the <code>ListRequestedServiceQuotaChangeHistory</code> command. Once a quota change request has reached <code>CASE_CLOSED, APPROVED,</code> or <code>DENIED</code>, the history has been kept for 90 days.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryByQuotaListCmdlet.QuotaCode"> <summary> <para> <para>Specifies the service quota that you want to use</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryByQuotaListCmdlet.ServiceCode"> <summary> <para> <para>Specifies the service that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryByQuotaListCmdlet.Status"> <summary> <para> <para>Specifies the status value of the quota increase request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryByQuotaListCmdlet.MaxResult"> <summary> <para> <para>(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the <code>NextToken</code> element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the call to the operation to get the next part of the results. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryByQuotaListCmdlet.NextToken"> <summary> <para> <para>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryListCmdlet"> <summary> Requests a list of the changes to quotas for a service.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryListCmdlet.ServiceCode"> <summary> <para> <para>Specifies the service that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryListCmdlet.Status"> <summary> <para> <para>Specifies the status value of the quota increase request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryListCmdlet.MaxResult"> <summary> <para> <para>(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the <code>NextToken</code> element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the call to the operation to get the next part of the results. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQRequestedServiceQuotaChangeHistoryListCmdlet.NextToken"> <summary> <para> <para>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceListCmdlet"> <summary> Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use <a>ListServiceQuotas</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceListCmdlet.MaxResult"> <summary> <para> <para>(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the <code>NextToken</code> element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the call to the operation to get the next part of the results. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceListCmdlet.NextToken"> <summary> <para> <para>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaCmdlet"> <summary> Returns the details for the specified service quota. This operation provides a different Value than the <code>GetAWSDefaultServiceQuota</code> operation. This operation returns the applied value for each quota. <code>GetAWSDefaultServiceQuota</code> returns the default AWS value for each quota. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaCmdlet.QuotaCode"> <summary> <para> <para>Identifies the service quota you want to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaCmdlet.ServiceCode"> <summary> <para> <para>Specifies the service that you want to use.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestFromTemplateCmdlet"> <summary> Returns the details of the service quota increase request in your template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestFromTemplateCmdlet.AwsRegion"> <summary> <para> <para>Specifies the AWS Region for the quota that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestFromTemplateCmdlet.QuotaCode"> <summary> <para> <para>Specifies the quota you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestFromTemplateCmdlet.ServiceCode"> <summary> <para> <para>Specifies the service that you want to use.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestsInTemplateListCmdlet"> <summary> Returns a list of the quota increase requests in the template.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestsInTemplateListCmdlet.AwsRegion"> <summary> <para> <para>Specifies the AWS Region for the quota that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestsInTemplateListCmdlet.ServiceCode"> <summary> <para> <para>The identifier for a service. When performing an operation, use the <code>ServiceCode</code> to specify a particular service. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestsInTemplateListCmdlet.MaxResult"> <summary> <para> <para>(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the <code>NextToken</code> element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the call to the operation to get the next part of the results. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaIncreaseRequestsInTemplateListCmdlet.NextToken"> <summary> <para> <para>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaListCmdlet"> <summary> Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you'll see the default values are the values that AWS provides for the quotas. <note><para> Always check the <code>NextToken</code> response parameter when calling any of the <code>List*</code> operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the <code>NextToken</code> response parameter contains a value to pass the next call to the same API to request the next part of the list. </para></note><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaListCmdlet.ServiceCode"> <summary> <para> <para>The identifier for a service. When performing an operation, use the <code>ServiceCode</code> to specify a particular service. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaListCmdlet.MaxResult"> <summary> <para> <para>(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the <code>NextToken</code> element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the call to the operation to get the next part of the results. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.GetSQServiceQuotaListCmdlet.NextToken"> <summary> <para> <para>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.RegisterSQServiceQuotaTemplateCmdlet"> <summary> Associates the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RegisterSQServiceQuotaTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.RemoveSQServiceQuotaIncreaseRequestFromTemplateCmdlet"> <summary> Removes a service quota increase request from the Service Quotas template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RemoveSQServiceQuotaIncreaseRequestFromTemplateCmdlet.AwsRegion"> <summary> <para> <para>Specifies the AWS Region for the quota that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RemoveSQServiceQuotaIncreaseRequestFromTemplateCmdlet.QuotaCode"> <summary> <para> <para>Specifies the code for the quota that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RemoveSQServiceQuotaIncreaseRequestFromTemplateCmdlet.ServiceCode"> <summary> <para> <para>Specifies the code for the service that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RemoveSQServiceQuotaIncreaseRequestFromTemplateCmdlet.PassThru"> <summary> Returns the value passed to the QuotaCode parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RemoveSQServiceQuotaIncreaseRequestFromTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.RequestSQServiceQuotaIncreaseCmdlet"> <summary> Retrieves the details of a service quota increase request. The response to this command provides the details in the <a>RequestedServiceQuotaChange</a> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RequestSQServiceQuotaIncreaseCmdlet.DesiredValue"> <summary> <para> <para>Specifies the value submitted in the service quota increase request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RequestSQServiceQuotaIncreaseCmdlet.QuotaCode"> <summary> <para> <para>Specifies the service quota that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RequestSQServiceQuotaIncreaseCmdlet.ServiceCode"> <summary> <para> <para>Specifies the service that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.RequestSQServiceQuotaIncreaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.UnregisterSQServiceQuotaTemplateCmdlet"> <summary> Disables the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template. <para><b>Related operations</b></para><ul><li><para> To enable the quota template, call <a>AssociateServiceQuotaTemplate</a>. </para></li><li><para> To delete a specific service quota from the template, use <a>DeleteServiceQuotaIncreaseRequestFromTemplate</a>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.UnregisterSQServiceQuotaTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQ.WriteSQServiceQuotaIncreaseRequestIntoTemplateCmdlet"> <summary> Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the <code>ServiceCode</code>, <code>QuotaCode</code>, <code>AwsRegion</code>, and <code>DesiredValue</code>. Once you add a quota to the template, use <a>ListServiceQuotaIncreaseRequestsInTemplate</a> to see the list of quotas in the template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.WriteSQServiceQuotaIncreaseRequestIntoTemplateCmdlet.AwsRegion"> <summary> <para> <para>Specifies the AWS Region for the quota. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.WriteSQServiceQuotaIncreaseRequestIntoTemplateCmdlet.DesiredValue"> <summary> <para> <para>Specifies the new, increased value for the quota. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.WriteSQServiceQuotaIncreaseRequestIntoTemplateCmdlet.QuotaCode"> <summary> <para> <para>Specifies the service quota that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.WriteSQServiceQuotaIncreaseRequestIntoTemplateCmdlet.ServiceCode"> <summary> <para> <para>Specifies the service that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQ.WriteSQServiceQuotaIncreaseRequestIntoTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |