Learn more  » Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Bower components Debian packages RPM packages NuGet packages

squarecapadmin / botocore   python

Repository URL to install this package:

/ botocore / data / support / 2013-04-15 / service-2.json

{
  "version":"2.0",
  "metadata":{
    "uid":"support-2013-04-15",
    "apiVersion":"2013-04-15",
    "endpointPrefix":"support",
    "jsonVersion":"1.1",
    "protocol":"json",
    "serviceFullName":"AWS Support",
    "signatureVersion":"v4",
    "targetPrefix":"AWSSupport_20130415"
  },
  "operations":{
    "AddAttachmentsToSet":{
      "name":"AddAttachmentsToSet",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"AddAttachmentsToSetRequest"},
      "output":{"shape":"AddAttachmentsToSetResponse"},
      "errors":[
        {"shape":"InternalServerError"},
        {"shape":"AttachmentSetIdNotFound"},
        {"shape":"AttachmentSetExpired"},
        {"shape":"AttachmentSetSizeLimitExceeded"},
        {"shape":"AttachmentLimitExceeded"}
      ],
      "documentation":"<p>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.</p> <p>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.</p>"
    },
    "AddCommunicationToCase":{
      "name":"AddCommunicationToCase",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"AddCommunicationToCaseRequest"},
      "output":{"shape":"AddCommunicationToCaseResponse"},
      "errors":[
        {"shape":"InternalServerError"},
        {"shape":"CaseIdNotFound"},
        {"shape":"AttachmentSetIdNotFound"},
        {"shape":"AttachmentSetExpired"}
      ],
      "documentation":"<p>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.</p> <p>The response indicates the success or failure of the request.</p> <p>This operation implements a subset of the features of the AWS Support Center.</p>"
    },
    "CreateCase":{
      "name":"CreateCase",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateCaseRequest"},
      "output":{"shape":"CreateCaseResponse"},
      "errors":[
        {"shape":"InternalServerError"},
        {"shape":"CaseCreationLimitExceeded"},
        {"shape":"AttachmentSetIdNotFound"},
        {"shape":"AttachmentSetExpired"}
      ],
      "documentation":"<p>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: </p> <ul> <li> <p> <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.\" </p> </li> <li> <p> <b>serviceCode.</b> The code for an AWS service. You obtain the <code>serviceCode</code> by calling <a>DescribeServices</a>. </p> </li> <li> <p> <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. </p> </li> <li> <p> <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>.</p> </li> <li> <p> <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.</p> </li> <li> <p> <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.</p> </li> <li> <p> <b>attachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</p> </li> <li> <p> <b>language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</p> </li> <li> <p> <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>. </p> </li> </ul> <note> <p>To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>.</p> </note> <p>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. </p>"
    },
    "DescribeAttachment":{
      "name":"DescribeAttachment",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeAttachmentRequest"},
      "output":{"shape":"DescribeAttachmentResponse"},
      "errors":[
        {"shape":"InternalServerError"},
        {"shape":"DescribeAttachmentLimitExceeded"},
        {"shape":"AttachmentIdNotFound"}
      ],
      "documentation":"<p>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.</p>"
    },
    "DescribeCases":{
      "name":"DescribeCases",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeCasesRequest"},
      "output":{"shape":"DescribeCasesResponse"},
      "errors":[
        {"shape":"InternalServerError"},
        {"shape":"CaseIdNotFound"}
      ],
      "documentation":"<p>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. </p> <p>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.</p> <p>The response returns the following in JSON format:</p> <ul> <li> <p>One or more <a>CaseDetails</a> data types. </p> </li> <li> <p>One or more <code>nextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</p> </li> </ul>"
    },
    "DescribeCommunications":{
      "name":"DescribeCommunications",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeCommunicationsRequest"},
      "output":{"shape":"DescribeCommunicationsResponse"},
      "errors":[
        {"shape":"InternalServerError"},
        {"shape":"CaseIdNotFound"}
      ],
      "documentation":"<p>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.</p> <p>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.</p> <p>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.</p>"
    },
    "DescribeServices":{
      "name":"DescribeServices",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeServicesRequest"},
      "output":{"shape":"DescribeServicesResponse"},
      "errors":[
        {"shape":"InternalServerError"}
      ],
      "documentation":"<p>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.</p> <p>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.</p>"
    },
    "DescribeSeverityLevels":{
      "name":"DescribeSeverityLevels",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeSeverityLevelsRequest"},
      "output":{"shape":"DescribeSeverityLevelsResponse"},
      "errors":[
        {"shape":"InternalServerError"}
      ],
      "documentation":"<p>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. </p>"
    },
    "DescribeTrustedAdvisorCheckRefreshStatuses":{
      "name":"DescribeTrustedAdvisorCheckRefreshStatuses",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesRequest"},
      "output":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesResponse"},
      "errors":[
        {"shape":"InternalServerError"}
      ],
      "documentation":"<p>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>.</p> <note> <p>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.</p> </note>"
    },
    "DescribeTrustedAdvisorCheckResult":{
      "name":"DescribeTrustedAdvisorCheckResult",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeTrustedAdvisorCheckResultRequest"},
      "output":{"shape":"DescribeTrustedAdvisorCheckResultResponse"},
      "errors":[
        {"shape":"InternalServerError"}
      ],
      "documentation":"<p>Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p> <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects:</p> <ul> <li> <p> <a>TrustedAdvisorCategorySpecificSummary</a> </p> </li> <li> <p> <a>TrustedAdvisorResourceDetail</a> </p> </li> <li> <p> <a>TrustedAdvisorResourcesSummary</a> </p> </li> </ul> <p>In addition, the response contains these fields:</p> <ul> <li> <p> <b>status.</b> The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</p> </li> <li> <p> <b>timestamp.</b> The time of the last refresh of the check.</p> </li> <li> <p> <b>checkId.</b> The unique identifier for the check.</p> </li> </ul>"
    },
    "DescribeTrustedAdvisorCheckSummaries":{
      "name":"DescribeTrustedAdvisorCheckSummaries",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeTrustedAdvisorCheckSummariesRequest"},
      "output":{"shape":"DescribeTrustedAdvisorCheckSummariesResponse"},
      "errors":[
        {"shape":"InternalServerError"}
      ],
      "documentation":"<p>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>.</p> <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects.</p>"
    },
    "DescribeTrustedAdvisorChecks":{
      "name":"DescribeTrustedAdvisorChecks",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeTrustedAdvisorChecksRequest"},
      "output":{"shape":"DescribeTrustedAdvisorChecksResponse"},
      "errors":[
        {"shape":"InternalServerError"}
      ],
      "documentation":"<p>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.</p>"
    },
    "RefreshTrustedAdvisorCheck":{
      "name":"RefreshTrustedAdvisorCheck",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"RefreshTrustedAdvisorCheckRequest"},
      "output":{"shape":"RefreshTrustedAdvisorCheckResponse"},
      "errors":[
        {"shape":"InternalServerError"}
      ],
      "documentation":"<p>Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p> <note> <p>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.</p> </note> <p>The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields:</p> <ul> <li> <p> <b>status.</b> The refresh status of the check: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</p> </li> <li> <p> <b>millisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</p> </li> <li> <p> <b>checkId.</b> The unique identifier for the check.</p> </li> </ul>"
    },
    "ResolveCase":{
      "name":"ResolveCase",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ResolveCaseRequest"},
      "output":{"shape":"ResolveCaseResponse"},
      "errors":[
        {"shape":"InternalServerError"},
        {"shape":"CaseIdNotFound"}
      ],
      "documentation":"<p>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.</p>"
    }
  },
  "shapes":{
    "AddAttachmentsToSetRequest":{
      "type":"structure",
      "required":["attachments"],
      "members":{
        "attachmentSetId":{
          "shape":"AttachmentSetId",
          "documentation":"<p>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.</p>"
        },
        "attachments":{
          "shape":"Attachments",
          "documentation":"<p>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.</p>"
        }
      },
      "documentation":"<p/>"
    },
    "AddAttachmentsToSetResponse":{
      "type":"structure",
      "members":{
        "attachmentSetId":{
          "shape":"AttachmentSetId",
          "documentation":"<p>The ID of the attachment set. If an <code>attachmentSetId</code> was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>attachmentSetId</code> was specified, the attachments are added to the specified set, if it exists.</p>"
        },
        "expiryTime":{
          "shape":"ExpiryTime",
          "documentation":"<p>The time and date when the attachment set expires.</p>"
        }
      },
      "documentation":"<p>The ID and expiry time of the attachment set returned by the <a>AddAttachmentsToSet</a> operation.</p>"
    },
    "AddCommunicationToCaseRequest":{
      "type":"structure",
      "required":["communicationBody"],
      "members":{
        "caseId":{
          "shape":"CaseId",
          "documentation":"<p>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> </p>"
        },
        "communicationBody":{
          "shape":"CommunicationBody",
          "documentation":"<p>The body of an email communication to add to the support case.</p>"
        },
        "ccEmailAddresses":{
          "shape":"CcEmailAddressList",
          "documentation":"<p>The email addresses in the CC line of an email to be added to the support case.</p>"
        },
        "attachmentSetId":{
          "shape":"AttachmentSetId",
          "documentation":"<p>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> </p>"
        }
      },
      "documentation":"<p>To be written.</p>"
    },
    "AddCommunicationToCaseResponse":{
      "type":"structure",
      "members":{
        "result":{
          "shape":"Result",
          "documentation":"<p>True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an error.</p>"
        }
      },
      "documentation":"<p>The result of the <a>AddCommunicationToCase</a> operation.</p>"
    },
    "AfterTime":{"type":"string"},
    "Attachment":{
      "type":"structure",
      "members":{
        "fileName":{
          "shape":"FileName",
          "documentation":"<p>The name of the attachment file.</p>"
        },
        "data":{
          "shape":"Data",
          "documentation":"<p>The content of the attachment file.</p>"
        }
      },
      "documentation":"<p>An attachment to a case communication. The attachment consists of the file name and the content of the file.</p>"
    },
    "AttachmentDetails":{
      "type":"structure",
      "members":{
        "attachmentId":{
          "shape":"AttachmentId",
          "documentation":"<p>The ID of the attachment.</p>"
        },
        "fileName":{
          "shape":"FileName",
          "documentation":"<p>The file name of the attachment.</p>"
        }
      },
      "documentation":"<p>The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the <a>DescribeAttachment</a> operation.</p>"
    },
    "AttachmentId":{"type":"string"},
    "AttachmentIdNotFound":{
      "type":"structure",
      "members":{
        "message":{
          "shape":"ErrorMessage",
          "documentation":"<p>An attachment with the specified ID could not be found.</p>"
        }
      },
      "documentation":"<p>An attachment with the specified ID could not be found.</p>",
      "exception":true
    },
    "AttachmentLimitExceeded":{
      "type":"structure",
      "members":{
        "message":{
          "shape":"ErrorMessage",
          "documentation":"<p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>"
        }
      },
      "documentation":"<p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>",
      "exception":true
    },
    "AttachmentSet":{
      "type":"list",
      "member":{"shape":"AttachmentDetails"}
    },
    "AttachmentSetExpired":{
      "type":"structure",
      "members":{
        "message":{
          "shape":"ErrorMessage",
          "documentation":"<p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>"
        }
      },
      "documentation":"<p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>",
      "exception":true
    },
    "AttachmentSetId":{"type":"string"},
    "AttachmentSetIdNotFound":{
      "type":"structure",
      "members":{
Loading ...