xception"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers (SIDs).

", "idempotent":true }, "DeleteConnector":{ "name":"DeleteConnector", "http":{ "method":"DELETE", "requestUri":"/connectors/{ConnectorArn}", "responseCode":202 }, "input":{"shape":"DeleteConnectorRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration action.

", "idempotent":true }, "DeleteDirectoryRegistration":{ "name":"DeleteDirectoryRegistration", "http":{ "method":"DELETE", "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}", "responseCode":202 }, "input":{"shape":"DeleteDirectoryRegistrationRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.

", "idempotent":true }, "DeleteServicePrincipalName":{ "name":"DeleteServicePrincipalName", "http":{ "method":"DELETE", "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}", "responseCode":202 }, "input":{"shape":"DeleteServicePrincipalNameRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.

", "idempotent":true }, "DeleteTemplate":{ "name":"DeleteTemplate", "http":{ "method":"DELETE", "requestUri":"/templates/{TemplateArn}", "responseCode":202 }, "input":{"shape":"DeleteTemplateRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.

", "idempotent":true }, "DeleteTemplateGroupAccessControlEntry":{ "name":"DeleteTemplateGroupAccessControlEntry", "http":{ "method":"DELETE", "requestUri":"/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}", "responseCode":200 }, "input":{"shape":"DeleteTemplateGroupAccessControlEntryRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a group access control entry.

", "idempotent":true }, "GetConnector":{ "name":"GetConnector", "http":{ "method":"GET", "requestUri":"/connectors/{ConnectorArn}", "responseCode":200 }, "input":{"shape":"GetConnectorRequest"}, "output":{"shape":"GetConnectorResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).

" }, "GetDirectoryRegistration":{ "name":"GetDirectoryRegistration", "http":{ "method":"GET", "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}", "responseCode":200 }, "input":{"shape":"GetDirectoryRegistrationRequest"}, "output":{"shape":"GetDirectoryRegistrationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

A structure that contains information about your directory registration.

" }, "GetServicePrincipalName":{ "name":"GetServicePrincipalName", "http":{ "method":"GET", "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}", "responseCode":200 }, "input":{"shape":"GetServicePrincipalNameRequest"}, "output":{"shape":"GetServicePrincipalNameResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the service principal name that the connector uses to authenticate with Active Directory.

" }, "GetTemplate":{ "name":"GetTemplate", "http":{ "method":"GET", "requestUri":"/templates/{TemplateArn}", "responseCode":200 }, "input":{"shape":"GetTemplateRequest"}, "output":{"shape":"GetTemplateResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves a certificate template that the connector uses to issue certificates from a private CA.

" }, "GetTemplateGroupAccessControlEntry":{ "name":"GetTemplateGroupAccessControlEntry", "http":{ "method":"GET", "requestUri":"/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}", "responseCode":200 }, "input":{"shape":"GetTemplateGroupAccessControlEntryRequest"}, "output":{"shape":"GetTemplateGroupAccessControlEntryResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Retrieves the group access control entries for a template.

" }, "ListConnectors":{ "name":"ListConnectors", "http":{ "method":"GET", "requestUri":"/connectors", "responseCode":200 }, "input":{"shape":"ListConnectorsRequest"}, "output":{"shape":"ListConnectorsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.

" }, "ListDirectoryRegistrations":{ "name":"ListDirectoryRegistrations", "http":{ "method":"GET", "requestUri":"/directoryRegistrations", "responseCode":200 }, "input":{"shape":"ListDirectoryRegistrationsRequest"}, "output":{"shape":"ListDirectoryRegistrationsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.

" }, "ListServicePrincipalNames":{ "name":"ListServicePrincipalNames", "http":{ "method":"GET", "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames", "responseCode":200 }, "input":{"shape":"ListServicePrincipalNamesRequest"}, "output":{"shape":"ListServicePrincipalNamesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the service principal names that the connector uses to authenticate with Active Directory.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the tags, if any, that are associated with your resource.

" }, "ListTemplateGroupAccessControlEntries":{ "name":"ListTemplateGroupAccessControlEntries", "http":{ "method":"GET", "requestUri":"/templates/{TemplateArn}/accessControlEntries", "responseCode":200 }, "input":{"shape":"ListTemplateGroupAccessControlEntriesRequest"}, "output":{"shape":"ListTemplateGroupAccessControlEntriesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists group access control entries you created.

" }, "ListTemplates":{ "name":"ListTemplates", "http":{ "method":"GET", "requestUri":"/templates", "responseCode":200 }, "input":{"shape":"ListTemplatesRequest"}, "output":{"shape":"ListTemplatesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Lists the templates, if any, that are associated with a connector.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{ResourceArn}", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Adds one or more tags to your resource.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{ResourceArn}", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Removes one or more tags from your resource.

", "idempotent":true }, "UpdateTemplate":{ "name":"UpdateTemplate", "http":{ "method":"PATCH", "requestUri":"/templates/{TemplateArn}", "responseCode":200 }, "input":{"shape":"UpdateTemplateRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Update template configuration to define the information included in certificates.

" }, "UpdateTemplateGroupAccessControlEntry":{ "name":"UpdateTemplateGroupAccessControlEntry", "http":{ "method":"PATCH", "requestUri":"/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}", "responseCode":200 }, "input":{"shape":"UpdateTemplateGroupAccessControlEntryRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

" } }, "shapes":{ "AccessControlEntry":{ "type":"structure", "members":{ "AccessRights":{ "shape":"AccessRights", "documentation":"

Permissions to allow or deny an Active Directory group to enroll or autoenroll certificates issued against a template.

" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"

The date and time that the Access Control Entry was created.

" }, "GroupDisplayName":{ "shape":"DisplayName", "documentation":"

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

" }, "GroupSecurityIdentifier":{ "shape":"GroupSecurityIdentifier", "documentation":"

Security identifier (SID) of the group object from Active Directory. The SID starts with \"S-\".

" }, "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"

The date and time that the Access Control Entry was updated.

" } }, "documentation":"

An access control entry allows or denies Active Directory groups based on their security identifiers (SIDs) from enrolling and/or autoenrolling with the template.

" }, "AccessControlEntryList":{ "type":"list", "member":{"shape":"AccessControlEntrySummary"} }, "AccessControlEntrySummary":{ "type":"structure", "members":{ "AccessRights":{ "shape":"AccessRights", "documentation":"

Allow or deny an Active Directory group from enrolling and autoenrolling certificates issued against a template.

" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"

The date and time that the Access Control Entry was created.

" }, "GroupDisplayName":{ "shape":"DisplayName", "documentation":"

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

" }, "GroupSecurityIdentifier":{ "shape":"GroupSecurityIdentifier", "documentation":"

Security identifier (SID) of the group object from Active Directory. The SID starts with \"S-\".

" }, "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"

The date and time that the Access Control Entry was updated.

" } }, "documentation":"

Summary of group access control entries that allow or deny Active Directory groups based on their security identifiers (SIDs) from enrolling and/or autofenrolling with the template.

" }, "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccessRight":{ "type":"string", "enum":[ "ALLOW", "DENY" ] }, "AccessRights":{ "type":"structure", "members":{ "AutoEnroll":{ "shape":"AccessRight", "documentation":"

Allow or deny an Active Directory group from autoenrolling certificates issued against a template. The Active Directory group must be allowed to enroll to allow autoenrollment

" }, "Enroll":{ "shape":"AccessRight", "documentation":"

Allow or deny an Active Directory group from enrolling certificates issued against a template.

" } }, "documentation":"

Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template.

" }, "ApplicationPolicies":{ "type":"structure", "required":["Policies"], "members":{ "Critical":{ "shape":"Boolean", "documentation":"

Marks the application policy extension as critical.

" }, "Policies":{ "shape":"ApplicationPolicyList", "documentation":"

Application policies describe what the certificate can be used for.

" } }, "documentation":"

Application policies describe what the certificate can be used for.

" }, "ApplicationPolicy":{ "type":"structure", "members":{ "PolicyObjectIdentifier":{ "shape":"CustomObjectIdentifier", "documentation":"

The object identifier (OID) of an application policy.

" }, "PolicyType":{ "shape":"ApplicationPolicyType", "documentation":"

The type of application policy

" } }, "documentation":"

Application policies describe what the certificate can be used for.

", "union":true }, "ApplicationPolicyList":{ "type":"list", "member":{"shape":"ApplicationPolicy"}, "max":100, "min":1 }, "ApplicationPolicyType":{ "type":"string", "enum":[ "ALL_APPLICATION_POLICIES", "ANY_PURPOSE", "ATTESTATION_IDENTITY_KEY_CERTIFICATE", "CERTIFICATE_REQUEST_AGENT", "CLIENT_AUTHENTICATION", "CODE_SIGNING", "CTL_USAGE", "DIGITAL_RIGHTS", "DIRECTORY_SERVICE_EMAIL_REPLICATION", "DISALLOWED_LIST", "DNS_SERVER_TRUST", "DOCUMENT_ENCRYPTION", "DOCUMENT_SIGNING", "DYNAMIC_CODE_GENERATOR", "EARLY_LAUNCH_ANTIMALWARE_DRIVER", "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "ENCLAVE", "ENCRYPTING_FILE_SYSTEM", "ENDORSEMENT_KEY_CERTIFICATE", "FILE_RECOVERY", "HAL_EXTENSION", "IP_SECURITY_END_SYSTEM", "IP_SECURITY_IKE_INTERMEDIATE", "IP_SECURITY_TUNNEL_TERMINATION", "IP_SECURITY_USER", "ISOLATED_USER_MODE", "KDC_AUTHENTICATION", "KERNEL_MODE_CODE_SIGNING", "KEY_PACK_LICENSES", "KEY_RECOVERY", "KEY_RECOVERY_AGENT", "LICENSE_SERVER_VERIFICATION", "LIFETIME_SIGNING", "MICROSOFT_PUBLISHER", "MICROSOFT_TIME_STAMPING", "MICROSOFT_TRUST_LIST_SIGNING", "OCSP_SIGNING", "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "PLATFORM_CERTIFICATE", "PREVIEW_BUILD_SIGNING", "PRIVATE_KEY_ARCHIVAL", "PROTECTED_PROCESS_LIGHT_VERIFICATION", "PROTECTED_PROCESS_VERIFICATION", "QUALIFIED_SUBORDINATION", "REVOKED_LIST_SIGNER", "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", "ROOT_LIST_SIGNER", "SECURE_EMAIL", "SERVER_AUTHENTICATION", "SMART_CARD_LOGIN", "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", "SPC_RELAXED_PE_MARKER_CHECK", "TIME_STAMPING", "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_VERIFICATION", "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", "WINDOWS_KITS_COMPONENT", "WINDOWS_RT_VERIFICATION", "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", "WINDOWS_STORE", "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "WINDOWS_TCB_COMPONENT", "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", "WINDOWS_UPDATE" ] }, "Boolean":{ "type":"boolean", "box":true }, "CertificateAuthorityArn":{ "type":"string", "max":200, "min":5, "pattern":"^arn:[\\w-]+:acm-pca:[\\w-]+:[0-9]+:certificate-authority\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" }, "CertificateValidity":{ "type":"structure", "required":[ "RenewalPeriod", "ValidityPeriod" ], "members":{ "RenewalPeriod":{ "shape":"ValidityPeriod", "documentation":"

Renewal period is the period of time before certificate expiration when a new certificate will be requested.

" }, "ValidityPeriod":{ "shape":"ValidityPeriod", "documentation":"

Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate. Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

" } }, "documentation":"

Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate. Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

" }, "ClientCompatibilityV2":{ "type":"string", "enum":[ "WINDOWS_SERVER_2003", "WINDOWS_SERVER_2008", "WINDOWS_SERVER_2008_R2", "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016" ] }, "ClientCompatibilityV3":{ "type":"string", "enum":[ "WINDOWS_SERVER_2008", "WINDOWS_SERVER_2008_R2", "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016" ] }, "ClientCompatibilityV4":{ "type":"string", "enum":[ "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016" ] }, "ClientToken":{ "type":"string", "max":64, "min":1, "pattern":"^[!-~]+$" }, "ConflictException":{ "type":"structure", "required":[ "Message", "ResourceId", "ResourceType" ], "members":{ "Message":{"shape":"String"}, "ResourceId":{ "shape":"String", "documentation":"

The identifier of the Amazon Web Services resource.

" }, "ResourceType":{ "shape":"String", "documentation":"

The resource type, which can be one of `Connector`, `Template`, `TemplateGroupAccessControlEntry`, `ServicePrincipalName`, or `DirectoryRegistration`.

" } }, "documentation":"

This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "Connector":{ "type":"structure", "members":{ "Arn":{ "shape":"ConnectorArn", "documentation":"

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" }, "CertificateAuthorityArn":{ "shape":"CertificateAuthorityArn", "documentation":"

The Amazon Resource Name (ARN) of the certificate authority being used.

" }, "CertificateEnrollmentPolicyServerEndpoint":{ "shape":"String", "documentation":"

Certificate enrollment endpoint for Active Directory domain-joined objects reach out to when requesting certificates.

" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"

The date and time that the connector was created.

" }, "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the Active Directory.

" }, "Status":{ "shape":"ConnectorStatus", "documentation":"

Status of the connector. Status can be creating, active, deleting, or failed.

" }, "StatusReason":{ "shape":"ConnectorStatusReason", "documentation":"

Additional informat{ "version":"2.0", "metadata":{ "apiVersion":"2013-04-15", "endpointPrefix":"support", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Support", "serviceId":"Support", "signatureVersion":"v4", "targetPrefix":"AWSSupport_20130415", "uid":"support-2013-04-15" }, "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":"

Adds one or more attachments to an attachment set.

An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The `expiryTime` returned in the response is when the set expires.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "AddCommunicationToCase":{ "name":"AddCommunicationToCase", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddCommunicationToCaseRequest"}, "output":{"shape":"AddCommunicationToCaseResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseIdNotFound"}, {"shape":"AttachmentSetIdNotFound"}, {"shape":"AttachmentSetExpired"} ], "documentation":"

Adds additional customer communication to an Amazon Web Services Support case. Use the `caseId` parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the `ccEmailAddresses` parameter. The `communicationBody` value contains the text of the communication.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "CreateCase":{ "name":"CreateCase", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCaseRequest"}, "output":{"shape":"CreateCaseResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseCreationLimitExceeded"}, {"shape":"AttachmentSetIdNotFound"}, {"shape":"AttachmentSetExpired"} ], "documentation":"

Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.

The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:

- Submit a request from the Amazon Web Services Support Center Create Case page.

- Use the Service Quotas RequestServiceQuotaIncrease operation.

A successful `CreateCase` request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.

The `caseId` is separate from the `displayId` that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the `displayId`.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "DescribeAttachment":{ "name":"DescribeAttachment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAttachmentRequest"}, "output":{"shape":"DescribeAttachmentResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"DescribeAttachmentLimitExceeded"}, {"shape":"AttachmentIdNotFound"} ], "documentation":"

Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. 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 AttachmentDetails objects that are returned by the DescribeCommunications operation.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "DescribeCases":{ "name":"DescribeCases", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCasesRequest"}, "output":{"shape":"DescribeCasesResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseIdNotFound"} ], "documentation":"

Returns a list of cases that you specify by passing one or more case IDs. You can use the `afterTime` and `beforeTime` parameters to filter the cases by date. You can set values for the `includeResolvedCases` and `includeCommunications` parameters to specify how much information to return.

The response returns the following in JSON format:

- One or more CaseDetails data types.

- One or more `nextToken` values, which specify where to paginate the returned records represented by the `CaseDetails` objects.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "DescribeCommunications":{ "name":"DescribeCommunications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCommunicationsRequest"}, "output":{"shape":"DescribeCommunicationsResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseIdNotFound"} ], "documentation":"

Returns communications and attachments for one or more support cases. Use the `afterTime` and `beforeTime` parameters to filter by date. You can use the `caseId` parameter to restrict the results to a specific case.

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.

You can use the `maxResults` and `nextToken` parameters to control the pagination of the results. Set `maxResults` to the number of cases that you want to display on each page, and use `nextToken` to specify the resumption of pagination.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "DescribeCreateCaseOptions":{ "name":"DescribeCreateCaseOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCreateCaseOptionsRequest"}, "output":{"shape":"DescribeCreateCaseOptionsResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the `language` `categoryCode`, `issueType` and `serviceCode` used to retrieve the CreateCaseOptions.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "DescribeServices":{ "name":"DescribeServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServicesRequest"}, "output":{"shape":"DescribeServicesResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.

The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the `DescribeServices` operation. Always use the service codes and categories that the `DescribeServices` operation returns, so that you have the most recent set of service and category codes.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "DescribeSeverityLevels":{ "name":"DescribeSeverityLevels", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSeverityLevelsRequest"}, "output":{"shape":"DescribeSeverityLevelsResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "DescribeSupportedLanguages":{ "name":"DescribeSupportedLanguages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSupportedLanguagesRequest"}, "output":{"shape":"DescribeSupportedLanguagesResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns a list of supported languages for a specified `categoryCode`, `issueType` and `serviceCode`. The returned supported languages will include a ISO 639-1 code for the `language`, and the language display name.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" }, "DescribeTrustedAdvisorCheckRefreshStatuses":{ "name":"DescribeTrustedAdvisorCheckRefreshStatuses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesRequest"}, "output":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

Some checks are refreshed automatically, and you can't return their refresh statuses by using the `DescribeTrustedAdvisorCheckRefreshStatuses` operation. If you call this operation for these checks, you might see an `InvalidParameterValue` error.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

" }, "DescribeTrustedAdvisorCheckResult":{ "name":"DescribeTrustedAdvisorCheckResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustedAdvisorCheckResultRequest"}, "output":{"shape":"DescribeTrustedAdvisorCheckResultResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

- TrustedAdvisorCategorySpecificSummary

- TrustedAdvisorResourceDetail

- TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

- status - The alert status of the check can be `ok` (green), `warning` (yellow), `error` (red), or `not_available`.

- timestamp - The time of the last refresh of the check.

- checkId - The unique identifier for the check.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

" }, "DescribeTrustedAdvisorCheckSummaries":{ "name":"DescribeTrustedAdvisorCheckSummaries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustedAdvisorCheckSummariesRequest"}, "output":{"shape":"DescribeTrustedAdvisorCheckSummariesResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

The response contains an array of TrustedAdvisorCheckSummary objects.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

" }, "DescribeTrustedAdvisorChecks":{ "name":"DescribeTrustedAdvisorChecks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustedAdvisorChecksRequest"}, "output":{"shape":"DescribeTrustedAdvisorChecksResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.

The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

- The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

" }, "RefreshTrustedAdvisorCheck":{ "name":"RefreshTrustedAdvisorCheck", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RefreshTrustedAdvisorCheckRequest"}, "output":{"shape":"RefreshTrustedAdvisorCheckResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

Some checks are refreshed automatically. If you call the `RefreshTrustedAdvisorCheck` operation to refresh them, you might see the `InvalidParameterValue` error.

The response contains a TrustedAdvisorCheckRefreshStatus object.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

" }, "ResolveCase":{ "name":"ResolveCase", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResolveCaseRequest"}, "output":{"shape":"ResolveCaseResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseIdNotFound"} ], "documentation":"

Resolves a support case. This operation takes a `caseId` and returns the initial and final state of the case.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

" } }, "shapes":{ "AddAttachmentsToSetRequest":{ "type":"structure", "required":["attachments"], "members":{ "attachmentSetId":{ "shape":"AttachmentSetId", "documentation":"

The ID of the attachment set. If an `attachmentSetId` is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an `attachmentSetId` is specified, the attachments are added to the specified set, if it exists.

" }, "attachments":{ "shape":"Attachments", "documentation":"

One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.

In the `Attachment` object, use the `data` parameter to specify the contents of the attachment file. In the previous request syntax, the value for `data` appear as `blob`, which is represented as a base64-encoded string. The value for `fileName` is the name of the attachment, such as `troubleshoot-screenshot.png`.

" } } }, "AddAttachmentsToSetResponse":{ "type":"structure", "members":{ "attachmentSetId":{ "shape":"AttachmentSetId", "documentation":"

The ID of the attachment set. If an `attachmentSetId` was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an `attachmentSetId` was specified, the attachments are added to the specified set, if it exists.

" }, "expiryTime":{ "shape":"ExpiryTime", "documentation":"

The time and date when the attachment set expires.

" } }, "documentation":"

The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

" }, "AddCommunicationToCaseRequest":{ "type":"structure", "required":["communicationBody"], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" }, "communicationBody":{ "shape":"CommunicationBody", "documentation":"

The body of an email communication to add to the support case.

" }, "ccEmailAddresses":{ "shape":"CcEmailAddressList", "documentation":"

The email addresses in the CC line of an email to be added to the support case.

" }, "attachmentSetId":{ "shape":"AttachmentSetId", "documentation":"

The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet

" } } }, "AddCommunicationToCaseResponse":{ "type":"structure", "members":{ "result":{ "shape":"Result", "documentation":"

True if AddCommunicationToCase succeeds. Otherwise, returns an error.

" } }, "documentation":"

The result of the AddCommunicationToCase operation.

" }, "AfterTime":{"type":"string"}, "Attachment":{ "type":"structure", "members":{ "fileName":{ "shape":"FileName", "documentation":"

The name of the attachment file.

" }, "data":{ "shape":"Data", "documentation":"

The content of the attachment file.

" } }, "documentation":"

An attachment to a case communication. The attachment consists of the file name and the content of the file.

" }, "AttachmentDetails":{ "type":"structure", "members":{ "attachmentId":{ "shape":"AttachmentId", "documentation":"

The ID of the attachment.

" }, "fileName":{ "shape":"FileName", "documentation":"

The file name of the attachment.

" } }, "documentation":"

The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

" }, "AttachmentId":{"type":"string"}, "AttachmentIdNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

An attachment with the specified ID could not be found.

" } }, "documentation":"

An attachment with the specified ID could not be found.

", "exception":true }, "AttachmentLimitExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The limit for the number of attachment sets created in a short period of time has been exceeded.

" } }, "documentation":"

The limit for the number of attachment sets created in a short period of time has been exceeded.

", "exception":true }, "AttachmentSet":{ "type":"list", "member":{"shape":"AttachmentDetails"} }, "AttachmentSetExpired":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The expiration time of the attachment set has passed. The set expires one hour after it is created.

" } }, "documentation":"

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

", "exception":true }, "AttachmentSetId":{"type":"string"}, "AttachmentSetIdNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

An attachment set with the specified ID could not be found.

" } }, "documentation":"

An attachment set with the specified ID could not be found.

", "exception":true }, "AttachmentSetSizeLimitExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.

" } }, "documentation":"

A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.

", "exception":true }, "Attachments":{ "type":"list", "member":{"shape":"Attachment"} }, "AvailabilityErrorMessage":{"type":"string"}, "BeforeTime":{"type":"string"}, "Boolean":{"type":"boolean"}, "CaseCreationLimitExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

An error message that indicates that you have exceeded the number of cases you can have open.

" } }, "documentation":"

The case creation limit for the account has been exceeded.

", "exception":true }, "CaseDetails":{ "type":"structure", "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" }, "displayId":{ "shape":"DisplayId", "documentation":"

The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

" }, "subject":{ "shape":"Subject", "documentation":"

The subject line for the case in the Amazon Web Services Support Center.

" }, "status":{ "shape":"Status", "documentation":"

The status of the case.

Valid values:

- `opened`

- `pending-customer-action`

- `reopened`

- `resolved`

- `unassigned`

- `work-in-progress`

" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"

The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

" }, "categoryCode":{ "shape":"CategoryCode", "documentation":"

The category of problem for the support case.

" }, "severityCode":{ "shape":"SeverityCode", "documentation":"

The code for the severity level returned by the call to DescribeSeverityLevels.

" }, "submittedBy":{ "shape":"SubmittedBy", "documentation":"

The email address of the account that submitted the case.

" }, "timeCreated":{ "shape":"TimeCreated", "documentation":"

The time that the case was created in the Amazon Web Services Support Center.

" }, "recentCommunications":{ "shape":"RecentCaseCommunications", "documentation":"

The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a `nextToken` that you can use to retrieve earlier communications.

" }, "ccEmailAddresses":{ "shape":"CcEmailAddressList", "documentation":"

The email addresses that receive copies of communication about the case.

" }, "language":{ "shape":"Language", "documentation":"

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language.

" } }, "documentation":"

A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:

- caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.

- categoryCode - The category of problem for the support case. Corresponds to the `CategoryCode` values returned by a call to DescribeServices.

- displayId - The identifier for the case on pages in the Amazon Web Services Support Center.

- language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language.

- nextToken - A resumption point for pagination.

- recentCommunications - One or more Communication objects. Fields of these objects are `attachments`, `body`, `caseId`, `submittedBy`, and `timeCreated`.

- serviceCode - The identifier for the Amazon Web Services service that corresponds to the service code defined in the call to DescribeServices.

- severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: `low`, `normal`, `high`, `urgent`, and `critical`.

- status - The status of the case in the Amazon Web Services Support Center. Valid values:

  - `opened`

  - `pending-customer-action`

  - `reopened`

  - `resolved`

  - `unassigned`

  - `work-in-progress`

- subject - The subject line of the case.

- submittedBy - The email address of the account that submitted the case.

- timeCreated - The time the case was created, in ISO-8601 format.

" }, "CaseId":{"type":"string"}, "CaseIdList":{ "type":"list", "member":{"shape":"CaseId"}, "max":100, "min":0 }, "CaseIdNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The requested `CaseId` could not be located.

" } }, "documentation":"

The requested `caseId` couldn't be located.

", "exception":true }, "CaseList":{ "type":"list", "member":{"shape":"CaseDetails"} }, "CaseStatus":{"type":"string"}, "Category":{ "type":"structure", "members":{ "code":{ "shape":"CategoryCode", "documentation":"

The category code for the support case.

" }, "name":{ "shape":"CategoryName", "documentation":"

The category name for the support case.

" } }, "documentation":"

A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each Amazon Web Services service.

" }, "CategoryCode":{"type":"string"}, "CategoryList":{ "type":"list", "member":{"shape":"Category"} }, "CategoryName":{"type":"string"}, "CcEmailAddress":{"type":"string"}, "CcEmailAddressList":{ "type":"list", "member":{"shape":"CcEmailAddress"}, "max":10, "min":0 }, "Code":{"type":"string"}, "Communication":{ "type":"structure", "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" }, "body":{ "shape":"ValidatedCommunicationBody", "documentation":"

The text of the communication between the customer and Amazon Web Services Support.

" }, "submittedBy":{ "shape":"SubmittedBy", "documentation":"

The identity of the account that submitted, or responded to, the support case. Customer entries include the IAM role as well as the email address (for example, \"AdminRole (Role) <janedoe@example.com>). Entries from the Amazon Web Services Support team display \"Amazon Web Services,\" and don't show an email address.

" }, "timeCreated":{ "shape":"TimeCreated", "documentation":"

The time the communication was created.

" }, "attachmentSet":{ "shape":"AttachmentSet", "documentation":"

Information about the attachments to the case communication.

" } }, "documentation":"

A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

" }, "CommunicationBody":{ "type":"string", "max":8000, "min":1 }, "CommunicationList":{ "type":"list", "member":{"shape":"Communication"} }, "CommunicationTypeOptions":{ "type":"structure", "members":{ "type":{ "shape":"Type", "documentation":"

A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call.

" }, "supportedHours":{ "shape":"SupportedHoursList", "documentation":"

A JSON-formatted list containing time ranges when support is available.

" }, "datesWithoutSupport":{ "shape":"DatesWithoutSupportList", "documentation":"

A JSON-formatted list containing date and time ranges for periods without support

" } }, "documentation":"

A JSON-formatted object that contains the CommunicationTypeOptions for creating a case for a certain communication channel. It is contained in the response from a DescribeCreateCaseOptions request. CommunicationTypeOptions contains the following fields:

- datesWithoutSupport - A JSON-formatted list containing date and time ranges for periods without support in UTC time. Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

- supportedHours - A JSON-formatted list containing time ranges when support are available. Time format is RFC 3339 : 'HH:mm:ss.SSS'.

- type - A string value indicating the communication type that the aforementioned rules apply to. At the moment the type value can assume one of 3 values at the moment `chat`, `web` and `call`.

" }, "CommunicationTypeOptionsList":{ "type":"list", "member":{"shape":"CommunicationTypeOptions"}, "max":100, "min":1 }, "CreateCaseRequest":{ "type":"structure", "required":[ "subject", "communicationBody" ], "members":{ "subject":{ "shape":"Subject", "documentation":"

The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible `serviceCode` values.

" }, "severityCode":{ "shape":"SeverityCode", "documentation":"

A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for `severityCode`.

For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide.

The availability of severity levels depends on the support plan for the Amazon Web Services account.

" }, "categoryCode":{ "shape":"CategoryCode", "documentation":"

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

" }, "communicationBody":{ "shape":"CommunicationBody", "documentation":"

The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.

" }, "ccEmailAddresses":{ "shape":"CcEmailAddressList", "documentation":"

A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.

" }, "language":{ "shape":"Language", "documentation":"

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language.

" }, "issueType":{ "shape":"IssueType", "documentation":"

The type of issue for the case. You can specify `customer-service` or `technical`. If you don't specify a value, the default is `technical`.

" }, "attachmentSetId":{ "shape":"AttachmentSetId", "documentation":"

The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.

" } } }, "CreateCaseResponse":{ "type":"structure", "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47

" } }, "documentation":"

The support case ID returned by a successful completion of the CreateCase operation.

" }, "Data":{"type":"blob"}, "DateInterval":{ "type":"structure", "members":{ "startDateTime":{ "shape":"ValidatedDateTime", "documentation":"

A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

" }, "endDateTime":{ "shape":"ValidatedDateTime", "documentation":"

End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

" } }, "documentation":"

Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

" }, "DatesWithoutSupportList":{ "type":"list", "member":{"shape":"DateInterval"} }, "DescribeAttachmentLimitExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

" } }, "documentation":"

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

", "exception":true }, "DescribeAttachmentRequest":{ "type":"structure", "required":["attachmentId"], "members":{ "attachmentId":{ "shape":"AttachmentId", "documentation":"

The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

" } } }, "DescribeAttachmentResponse":{ "type":"structure", "members":{ "attachment":{ "shape":"Attachment", "documentation":"

This object includes the attachment content and file name.

In the previous response syntax, the value for the `data` parameter appears as `blob`, which is represented as a base64-encoded string. The value for `fileName` is the name of the attachment, such as `troubleshoot-screenshot.png`.

" } }, "documentation":"

The content and file name of the attachment returned by the DescribeAttachment operation.

" }, "DescribeCasesRequest":{ "type":"structure", "members":{ "caseIdList":{ "shape":"CaseIdList", "documentation":"

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

" }, "displayId":{ "shape":"DisplayId", "documentation":"

The ID displayed for a case in the Amazon Web Services Support Center user interface.

" }, "afterTime":{ "shape":"AfterTime", "documentation":"

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" }, "beforeTime":{ "shape":"BeforeTime", "documentation":"

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" }, "includeResolvedCases":{ "shape":"IncludeResolvedCases", "documentation":"

Specifies whether to include resolved support cases in the `DescribeCases` response. By default, resolved cases aren't included.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return before paginating.

" }, "language":{ "shape":"Language", "documentation":"

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language.

" }, "includeCommunications":{ "shape":"IncludeCommunications", "documentation":"

Specifies whether to include communications in the `DescribeCases` response. By default, communications are included.

" } } }, "DescribeCasesResponse":{ "type":"structure", "members":{ "cases":{ "shape":"CaseList", "documentation":"

The details for the cases that match the request.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" } }, "documentation":"

Returns an array of CaseDetails objects and a `nextToken` that defines a point for pagination in the result set.

" }, "DescribeCommunicationsRequest":{ "type":"structure", "required":["caseId"], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" }, "beforeTime":{ "shape":"BeforeTime", "documentation":"

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" }, "afterTime":{ "shape":"AfterTime", "documentation":"

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return before paginating.

" } } }, "DescribeCommunicationsResponse":{ "type":"structure", "members":{ "communications":{ "shape":"CommunicationList", "documentation":"

The communications for the case.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" } }, "documentation":"

The communications returned by the DescribeCommunications operation.

" }, "DescribeCreateCaseOptionsRequest":{ "type":"structure", "required":[ "issueType", "serviceCode", "language", "categoryCode" ], "members":{ "issueType":{ "shape":"IssueType", "documentation":"

The type of issue for the case. You can specify `customer-service` or `technical`. If you don't specify a value, the default is `technical`.

" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible `serviceCode` values.

" }, "language":{ "shape":"Language", "documentation":"

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language.

" }, "categoryCode":{ "shape":"CategoryCode", "documentation":"

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

" } } }, "DescribeCreateCaseOptionsResponse":{ "type":"structure", "members":{ "languageAvailability":{ "shape":"ValidatedLanguageAvailability", "documentation":"

Language availability can be any of the following:

- available

- best_effort

- unavailable

" }, "communicationTypes":{ "shape":"CommunicationTypeOptionsList", "documentation":"

A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.

" } } }, "DescribeServicesRequest":{ "type":"structure", "members":{ "serviceCodeList":{ "shape":"ServiceCodeList", "documentation":"

A JSON-formatted list of service codes available for Amazon Web Services services.

" }, "language":{ "shape":"Language", "documentation":"

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language.

" } } }, "DescribeServicesResponse":{ "type":"structure", "members":{ "services":{ "shape":"ServiceList", "documentation":"

A JSON-formatted list of Amazon Web Services services.

" } }, "documentation":"

The list of Amazon Web Services services returned by the DescribeServices operation.

" }, "DescribeSeverityLevelsRequest":{ "type":"structure", "members":{ "language":{ "shape":"Language", "documentation":"

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese (\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language.

" } } }, "DescribeSeverityLevelsResponse":{ "type":"structure", "members":{ "severityLevels":{ "shape":"SeverityLevelsList", "documentation":"

The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.

" } }, "documentation":"

The list of severity levels returned by the DescribeSeverityLevels operation.

" }, "DescribeSupportedLanguagesRequest":{ "type":"structure", "required":[ "issueType", "serviceCode", "categoryCode" ], "members":{ "issueType":{ "shape":"ValidatedIssueTypeString", "documentation":"

The type of issue for the case. You can specify `customer-service` or `technical`.

" }, "serviceCode":{ "shape":"ValidatedServiceCode", "documentation":"

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible `serviceCode` values.

" }, "categoryCode":{ "shape":"ValidatedCategoryCode", "documentation":"

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

" } } }, "DescribeSupportedLanguagesResponse":{ "type":"structure", "members":{ "supportedLanguages":{ "shape":"SupportedLanguagesList", "documentation":"

A JSON-formatted array that contains the available ISO 639-1 language codes.

" } } }, "DescribeTrustedAdvisorCheckRefreshStatusesRequest":{ "type":"structure", "required":["checkIds"], "members":{ "checkIds":{ "shape":"StringList", "documentation":"

The IDs of the Trusted Advisor checks to get the status.

If you specify the check ID of a check that is automatically refreshed, you might see an `InvalidParameterValue` error.

" } } }, "DescribeTrustedAdvisorCheckRefreshStatusesResponse":{ "type":"structure", "required":["statuses"], "members":{ "statuses":{ "shape":"TrustedAdvisorCheckRefreshStatusList", "documentation":"

The refresh status of the specified Trusted Advisor checks.

" } }, "documentation":"

The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

" }, "DescribeTrustedAdvisorCheckResultRequest":{ "type":"structure", "required":["checkId"], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "language":{ "shape":"String", "documentation":"

The ISO 639-1 code for the language that you want your check results to appear in.

The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:

- Chinese, Simplified - `zh`

- Chinese, Traditional - `zh_TW`

- English - `en`

- French - `fr`

- German - `de`

- Indonesian - `id`

- Italian - `it`

- Japanese - `ja`

- Korean - `ko`

- Portuguese, Brazilian - `pt_BR`

- Spanish - `es`

" } }, "documentation":"

" }, "DescribeTrustedAdvisorCheckResultResponse":{ "type":"structure", "members":{ "result":{ "shape":"TrustedAdvisorCheckResult", "documentation":"

The detailed results of the Trusted Advisor check.

" } }, "documentation":"

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

" }, "DescribeTrustedAdvisorCheckSummariesRequest":{ "type":"structure", "required":["checkIds"], "members":{ "checkIds":{ "shape":"StringList", "documentation":"

The IDs of the Trusted Advisor checks.

" } } }, "DescribeTrustedAdvisorCheckSummariesResponse":{ "type":"structure", "required":["summaries"], "members":{ "summaries":{ "shape":"TrustedAdvisorCheckSummaryList", "documentation":"

The summary information for the requested Trusted Advisor checks.

" } }, "documentation":"

The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

" }, "DescribeTrustedAdvisorChecksRequest":{ "type":"structure", "required":["language"], "members":{ "language":{ "shape":"String", "documentation":"

The ISO 639-1 code for the language that you want your checks to appear in.

The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:

- Chinese, Simplified - `zh`

- Chinese, Traditional - `zh_TW`

- English - `en`

- French - `fr`

- German - `de`

- Indonesian - `id`

- Italian - `it`

- Japanese - `ja`

- Korean - `ko`

- Portuguese, Brazilian - `pt_BR`

- Spanish - `es`

" } } }, "DescribeTrustedAdvisorChecksResponse":{ "type":"structure", "required":["checks"], "members":{ "checks":{ "shape":"TrustedAdvisorCheckList", "documentation":"

Information about all available Trusted Advisor checks.

" } }, "documentation":"

Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

" }, "Display":{"type":"string"}, "DisplayId":{"type":"string"}, "Double":{"type":"double"}, "EndTime":{"type":"string"}, "ErrorMessage":{"type":"string"}, "ExpiryTime":{"type":"string"}, "FileName":{"type":"string"}, "IncludeCommunications":{"type":"boolean"}, "IncludeResolvedCases":{"type":"boolean"}, "InternalServerError":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

An internal server error occurred.

" } }, "documentation":"

An internal server error occurred.

", "exception":true, "fault":true }, "IssueType":{"type":"string"}, "Language":{"type":"string"}, "Long":{"type":"long"}, "MaxResults":{ "type":"integer", "max":100, "min":10 }, "NextToken":{"type":"string"}, "RecentCaseCommunications":{ "type":"structure", "members":{ "communications":{ "shape":"CommunicationList", "documentation":"

The five most recent communications associated with the case.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" } }, "documentation":"

The five most recent communications associated with the case.

" }, "RefreshTrustedAdvisorCheckRequest":{ "type":"structure", "required":["checkId"], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check to refresh.

Specifying the check ID of a check that is automatically refreshed causes an `InvalidParameterValue` error.

" } }, "documentation":"

" }, "RefreshTrustedAdvisorCheckResponse":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"TrustedAdvisorCheckRefreshStatus", "documentation":"

The current refresh status for a check, including the amount of time until the check is eligible for refresh.

" } }, "documentation":"

The current refresh status of a Trusted Advisor check.

" }, "ResolveCaseRequest":{ "type":"structure", "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" } } }, "ResolveCaseResponse":{ "type":"structure", "members":{ "initialCaseStatus":{ "shape":"CaseStatus", "documentation":"

The status of the case when the ResolveCase request was sent.

" }, "finalCaseStatus":{ "shape":"CaseStatus", "documentation":"

The status of the case after the ResolveCase request was processed.

" } }, "documentation":"

The status of the case returned by the ResolveCase operation.

" }, "Result":{"type":"boolean"}, "Service":{ "type":"structure", "members":{ "code":{ "shape":"ServiceCode", "documentation":"

The code for an Amazon Web Services service returned by the DescribeServices response. The `name` element contains the corresponding friendly name.

" }, "name":{ "shape":"ServiceName", "documentation":"

The friendly name for an Amazon Web Services service. The `code` element contains the corresponding code.

" }, "categories":{ "shape":"CategoryList", "documentation":"

A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to Amazon Web Services Support when you call CreateCase.

" } }, "documentation":"

Information about an Amazon Web Services service returned by the DescribeServices operation.

" }, "ServiceCode":{"type":"string"}, "ServiceCodeList":{ "type":"list", "member":{"shape":"ServiceCode"}, "max":100, "min":0 }, "ServiceList":{ "type":"list", "member":{"shape":"Service"} }, "ServiceName":{"type":"string"}, "SeverityCode":{"type":"string"}, "SeverityLevel":{ "type":"structure", "members":{ "code":{ "shape":"SeverityLevelCode", "documentation":"

The code for case severity level.

Valid values: `low` | `normal` | `high` | `urgent` | `critical`

" }, "name":{ "shape":"SeverityLevelName", "documentation":"

The name of the severity level that corresponds to the severity level code.

The values returned by the API are different from the values that appear in the Amazon Web Services Support Center. For example, the API uses the code `low`, but the name appears as General guidance in Support Center.

The following are the API code names and how they appear in the console:

- `low` - General guidance

- `normal` - System impaired

- `high` - Production system impaired

- `urgent` - Production system down

- `critical` - Business-critical system down

For more information, see Choosing a severity in the Amazon Web Services Support User Guide.

" } }, "documentation":"

A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a severity in the Amazon Web Services Support User Guide.

" }, "SeverityLevelCode":{"type":"string"}, "SeverityLevelName":{"type":"string"}, "SeverityLevelsList":{ "type":"list", "member":{"shape":"SeverityLevel"} }, "StartTime":{"type":"string"}, "Status":{"type":"string"}, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "Subject":{"type":"string"}, "SubmittedBy":{"type":"string"}, "SupportedHour":{ "type":"structure", "members":{ "startTime":{ "shape":"StartTime", "documentation":"

Start Time. RFC 3339 format `'HH:mm:ss.SSS'`.

" }, "endTime":{ "shape":"EndTime", "documentation":"

End Time. RFC 3339 format `'HH:mm:ss.SSS'`.

" } }, "documentation":"

Time range object with `startTime` and `endTime` range in RFC 3339 format. `'HH:mm:ss.SSS'`.

" }, "SupportedHoursList":{ "type":"list", "member":{"shape":"SupportedHour"} }, "SupportedLanguage":{ "type":"structure", "members":{ "code":{ "shape":"Code", "documentation":"

2 digit ISO 639-1 code. e.g. `en`

" }, "language":{ "shape":"Language", "documentation":"

Full language description e.g. `ENGLISH`

" }, "display":{ "shape":"Display", "documentation":"

Language display value e.g. `ENGLISH`

" } }, "documentation":"

A JSON-formatted object that contains the available ISO 639-1 language `code`, `language` name and langauge `display` value. The language code is what should be used in the CreateCase call.

" }, "SupportedLanguagesList":{ "type":"list", "member":{"shape":"SupportedLanguage"}, "max":100, "min":0 }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"AvailabilityErrorMessage"} }, "documentation":"

You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.

", "exception":true, "synthetic":true }, "TimeCreated":{"type":"string"}, "TrustedAdvisorCategorySpecificSummary":{ "type":"structure", "members":{ "costOptimizing":{ "shape":"TrustedAdvisorCostOptimizingSummary", "documentation":"

The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

" } }, "documentation":"

The container for summary information that relates to the category of the Trusted Advisor check.

" }, "TrustedAdvisorCheckDescription":{ "type":"structure", "required":[ "id", "name", "description", "category", "metadata" ], "members":{ "id":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "name":{ "shape":"String", "documentation":"

The display name for the Trusted Advisor check.

" }, "description":{ "shape":"String", "documentation":"

The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).

" }, "category":{ "shape":"String", "documentation":"

The category of the Trusted Advisor check.

" }, "metadata":{ "shape":"StringList", "documentation":"

The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

" } }, "documentation":"

The description and metadata for a Trusted Advisor check.

" }, "TrustedAdvisorCheckList":{ "type":"list", "member":{"shape":"TrustedAdvisorCheckDescription"} }, "TrustedAdvisorCheckRefreshStatus":{ "type":"structure", "required":[ "checkId", "status", "millisUntilNextRefreshable" ], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "status":{ "shape":"String", "documentation":"

The status of the Trusted Advisor check for which a refresh has been requested:

- `none` - The check is not refreshed or the non-success status exceeds the timeout

- `enqueued` - The check refresh requests has entered the refresh queue

- `processing` - The check refresh request is picked up by the rule processing engine

- `success` - The check is successfully refreshed

- `abandoned` - The check refresh has failed

" }, "millisUntilNextRefreshable":{ "shape":"Long", "documentation":"

The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

" } }, "documentation":"

The refresh status of a Trusted Advisor check.

" }, "TrustedAdvisorCheckRefreshStatusList":{ "type":"list", "member":{"shape":"TrustedAdvisorCheckRefreshStatus"} }, "TrustedAdvisorCheckResult":{ "type":"structure", "required":[ "checkId", "timestamp", "status", "resourcesSummary", "categorySpecificSummary", "flaggedResources" ], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "timestamp":{ "shape":"String", "documentation":"

The time of the last refresh of the check.

" }, "status":{ "shape":"String", "documentation":"

The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

" }, "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, "categorySpecificSummary":{ "shape":"TrustedAdvisorCategorySpecificSummary", "documentation":"

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

" }, "flaggedResources":{ "shape":"TrustedAdvisorResourceDetailList", "documentation":"

The details about each resource listed in the check result.

" } }, "documentation":"

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

" }, "TrustedAdvisorCheckSummary":{ "type":"structure", "required":[ "checkId", "timestamp", "status", "resourcesSummary", "categorySpecificSummary" ], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "timestamp":{ "shape":"String", "documentation":"

The time of the last refresh of the check.

" }, "status":{ "shape":"String", "documentation":"

The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

" }, "hasFlaggedResources":{ "shape":"Boolean", "documentation":"

Specifies whether the Trusted Advisor check has flagged resources.

" }, "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, "categorySpecificSummary":{ "shape":"TrustedAdvisorCategorySpecificSummary", "documentation":"

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

" } }, "documentation":"

A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

" }, "TrustedAdvisorCheckSummaryList":{ "type":"list", "member":{"shape":"TrustedAdvisorCheckSummary"} }, "TrustedAdvisorCostOptimizingSummary":{ "type":"structure", "required":[ "estimatedMonthlySavings", "estimatedPercentMonthlySavings" ], "members":{ "estimatedMonthlySavings":{ "shape":"Double", "documentation":"

The estimated monthly savings that might be realized if the recommended operations are taken.

" }, "estimatedPercentMonthlySavings":{ "shape":"Double", "documentation":"

The estimated percentage of savings that might be realized if the recommended operations are taken.

" } }, "documentation":"

The estimated cost savings that might be realized if the recommended operations are taken.

" }, "TrustedAdvisorResourceDetail":{ "type":"structure", "required":[ "status", "resourceId", "metadata" ], "members":{ "status":{ "shape":"String", "documentation":"

The status code for the resource identified in the Trusted Advisor check.

" }, "region":{ "shape":"String", "documentation":"

The Amazon Web Services Region in which the identified resource is located.

" }, "resourceId":{ "shape":"String", "documentation":"

The unique identifier for the identified resource.

" }, "isSuppressed":{ "shape":"Boolean", "documentation":"

Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

" }, "metadata":{ "shape":"StringList", "documentation":"

Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

" } }, "documentation":"

Contains information about a resource identified by a Trusted Advisor check.

" }, "TrustedAdvisorResourceDetailList":{ "type":"list", "member":{"shape":"TrustedAdvisorResourceDetail"} }, "TrustedAdvisorResourcesSummary":{ "type":"structure", "required":[ "resourcesProcessed", "resourcesFlagged", "resourcesIgnored", "resourcesSuppressed" ], "members":{ "resourcesProcessed":{ "shape":"Long", "documentation":"

The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.

" }, "resourcesFlagged":{ "shape":"Long", "documentation":"

The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.

" }, "resourcesIgnored":{ "shape":"Long", "documentation":"

The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.

" }, "resourcesSuppressed":{ "shape":"Long", "documentation":"

The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.

" } }, "documentation":"

Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

" }, "Type":{"type":"string"}, "ValidatedCategoryCode":{ "type":"string", "max":100, "min":0 }, "ValidatedCommunicationBody":{ "type":"string", "max":8000, "min":1 }, "ValidatedDateTime":{ "type":"string", "max":30, "min":8 }, "ValidatedIssueTypeString":{ "type":"string", "max":22, "min":9 }, "ValidatedLanguageAvailability":{ "type":"string", "max":100, "min":0 }, "ValidatedServiceCode":{ "type":"string", "max":100, "min":0 } }, "documentation":"Amazon Web Services Support

The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.

- You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

- If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see Amazon Web Services Support.

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

You can manage your support cases with the following Amazon Web Services Support API operations:

- The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.

- The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.

- The DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.

For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

" }