AWS.Tools.AWSSupport.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AWSSupport</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ASA.AddASAAttachmentsToSetCmdlet"> <summary> Adds one or more attachments to an attachment set. If an <code>attachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>attachmentSetId</code> is specified, the attachments are added to the specified set, if it exists. <para> An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>expiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASAAttachmentsToSetCmdlet.Attachment"> <summary> <para> <para>One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASAAttachmentsToSetCmdlet.AttachmentSetId"> <summary> <para> <para>The ID of the attachment set. If an <code>attachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>attachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASAAttachmentsToSetCmdlet.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.ASA.AddASACommunicationToCaseCmdlet"> <summary> Adds additional customer communication to an AWS Support case. You use the <code>caseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>ccEmailAddresses</code> value. The <code>communicationBody</code> value contains the text of the communication. <para> The response indicates the success or failure of the request. </para><para> This operation implements a subset of the features of the AWS Support Center. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.AttachmentSetId"> <summary> <para> <para>The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling <a>AddAttachmentsToSet</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.CaseId"> <summary> <para> <para>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.CcEmailAddress"> <summary> <para> <para>The email addresses in the CC line of an email to be added to the support case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.CommunicationBody"> <summary> <para> <para>The body of an email communication to add to the support case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.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.ASA.GetASAAttachmentCmdlet"> <summary> Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASAAttachmentCmdlet.AttachmentId"> <summary> <para> <para>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet"> <summary> Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>afterTime</code> and <code>beforeTime</code> request parameters. You can set values for the <code>includeResolvedCases</code> and <code>includeCommunications</code> request parameters to control how much information is returned. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para><para> The response returns the following in JSON format: </para><ul><li><para> One or more <a>CaseDetails</a> data types. </para></li><li><para> One or more <code>nextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects. </para></li></ul><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.ASA.GetASACaseCmdlet.AfterTime"> <summary> <para> <para>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet.BeforeTime"> <summary> <para> <para>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet.CaseIdList"> <summary> <para> <para>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet.DisplayId"> <summary> <para> <para>The ID displayed for a case in the AWS Support Center user interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet.IncludeCommunication"> <summary> <para> <para>Specifies whether communications should be included in the <a>DescribeCases</a> results. The default is <i>true</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet.IncludeResolvedCase"> <summary> <para> <para>Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results. The default is <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return before paginating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACaseCmdlet.NextToken"> <summary> <para> <para>A resumption point for pagination.</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.ASA.GetASACommunicationCmdlet"> <summary> Returns communications (and attachments) for one or more support cases. You can use the <code>afterTime</code> and <code>beforeTime</code> parameters to filter by date. You can use the <code>caseId</code> parameter to restrict the results to a particular case. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para><para> You can use the <code>maxResults</code> and <code>nextToken</code> parameters to control the pagination of the result set. Set <code>maxResults</code> to the number of cases you want displayed on each page, and use <code>nextToken</code> to specify the resumption of pagination. </para><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.ASA.GetASACommunicationCmdlet.AfterTime"> <summary> <para> <para>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationCmdlet.BeforeTime"> <summary> <para> <para>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationCmdlet.CaseId"> <summary> <para> <para>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return before paginating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationCmdlet.NextToken"> <summary> <para> <para>A resumption point for pagination.</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.ASA.GetASAServiceCmdlet"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASAServiceCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASAServiceCmdlet.ServiceCodeList"> <summary> <para> <para>A JSON-formatted list of service codes available for AWS services.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASASeverityLevelCmdlet"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASASeverityLevelCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckCmdlet"> <summary> Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckRefreshStatusCmdlet"> <summary> Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <note><para> Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the <code>DescribeTrustedAdvisorCheckRefreshStatuses</code> operation for these checks causes an <code>InvalidParameterValue</code> error. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckRefreshStatusCmdlet.CheckId"> <summary> <para> <para>The IDs of the Trusted Advisor checks to get the status of. <b>Note:</b> Specifying the check ID of a check that is automatically refreshed causes an <code>InvalidParameterValue</code> error.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckResultCmdlet"> <summary> Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects: </para><ul><li><para><a>TrustedAdvisorCategorySpecificSummary</a></para></li><li><para><a>TrustedAdvisorResourceDetail</a></para></li><li><para><a>TrustedAdvisorResourcesSummary</a></para></li></ul><para> In addition, the response contains these fields: </para><ul><li><para><b>status.</b> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". </para></li><li><para><b>timestamp.</b> The time of the last refresh of the check. </para></li><li><para><b>checkId.</b> The unique identifier for the check. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckResultCmdlet.CheckId"> <summary> <para> <para>The unique identifier for the Trusted Advisor check.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckResultCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckSummaryCmdlet"> <summary> Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckSummaryCmdlet.CheckId"> <summary> <para> <para>The IDs of the Trusted Advisor checks.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet"> <summary> Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. Its parameters require you to specify the following information: <ul><li><para><b>issueType.</b> The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." </para></li><li><para><b>serviceCode.</b> The code for an AWS service. You obtain the <code>serviceCode</code> by calling <a>DescribeServices</a>. </para></li><li><para><b>categoryCode.</b> The category for the service defined for the <code>serviceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </para></li><li><para><b>severityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>. </para></li><li><para><b>subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. </para></li><li><para><b>communicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. </para></li><li><para><b>attachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>. </para></li><li><para><b>language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported. </para></li><li><para><b>ccEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href="http://aws.amazon.com/tools/">AWS SDK</a>. </para></li></ul><note><para> To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>. </para></note><para> A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.AttachmentSetId"> <summary> <para> <para>The ID of a set of one or more attachments for the case. Create the set by using <a>AddAttachmentsToSet</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.CategoryCode"> <summary> <para> <para>The category of problem for the AWS Support case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.CcEmailAddress"> <summary> <para> <para>A list of email addresses that AWS Support copies on case correspondence.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.CommunicationBody"> <summary> <para> <para>The communication body text when you create an AWS Support case by calling <a>CreateCase</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.IssueType"> <summary> <para> <para>The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.ServiceCode"> <summary> <para> <para>The code for the AWS service returned by the call to <a>DescribeServices</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.SeverityCode"> <summary> <para> <para>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</para><note><para>The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.Subject"> <summary> <para> <para>The title of the AWS Support case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.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.ASA.RequestASATrustedAdvisorCheckRefreshCmdlet"> <summary> Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <note><para> Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the <code>RefreshTrustedAdvisorCheck</code> operation for these checks causes an <code>InvalidParameterValue</code> error. </para></note><para> The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields: </para><ul><li><para><b>status.</b> The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned". </para></li><li><para><b>millisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh. </para></li><li><para><b>checkId.</b> The unique identifier for the check. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.RequestASATrustedAdvisorCheckRefreshCmdlet.CheckId"> <summary> <para> <para>The unique identifier for the Trusted Advisor check to refresh. <b>Note:</b> Specifying the check ID of a check that is automatically refreshed causes an <code>InvalidParameterValue</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.RequestASATrustedAdvisorCheckRefreshCmdlet.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.ASA.ResolveASACaseCmdlet"> <summary> Takes a <code>caseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.ResolveASACaseCmdlet.CaseId"> <summary> <para> <para>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.ResolveASACaseCmdlet.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> |