/ 
Paws-0.23
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Support

NAME

Paws::Support - Perl Interface to AWS AWS Support

SYNOPSIS

use Paws;

my $obj = Paws->service('Support');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

AWS Support

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

The following list describes the AWS Support case management operations:

  • Service names, issue categories, and available severity levels. The DescribeServices and DescribeSeverityLevels operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.

  • Case creation, case details, and case resolution. The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create AWS Support cases, retrieve information about cases, and resolve cases.

  • Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases.

The following list describes the operations available from the AWS Support service for Trusted Advisor:

  • DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.

  • Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified.

  • DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.

  • RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check.

  • DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks.

For authentication of requests, AWS Support uses Signature Version 4 Signing Process.

See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

METHODS

AddAttachmentsToSet(Attachments => ArrayRef[Paws::Support::Attachment], [AttachmentSetId => Str])

Each argument is described in detail in: Paws::Support::AddAttachmentsToSet

Returns: a Paws::Support::AddAttachmentsToSetResponse instance

Adds one or more attachments to an attachment set. If an
C<AttachmentSetId> is not specified, a new attachment set is created,
and the ID of the set is returned in the response. If an
C<AttachmentSetId> is specified, the attachments are added to the
specified set, if it exists.

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 ExpiryTime 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.

AddCommunicationToCase(CommunicationBody => Str, [AttachmentSetId => Str, CaseId => Str, CcEmailAddresses => ArrayRef[Str]])

Each argument is described in detail in: Paws::Support::AddCommunicationToCase

Returns: a Paws::Support::AddCommunicationToCaseResponse instance

Adds additional customer communication to an AWS Support case. You use
the C<CaseId> value to identify the case to add communication to. You
can list a set of email addresses to copy on the communication using
the C<CcEmailAddresses> value. The C<CommunicationBody> value contains
the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

CreateCase(CommunicationBody => Str, Subject => Str, [AttachmentSetId => Str, CategoryCode => Str, CcEmailAddresses => ArrayRef[Str], IssueType => Str, Language => Str, ServiceCode => Str, SeverityCode => Str])

Each argument is described in detail in: Paws::Support::CreateCase

Returns: a Paws::Support::CreateCaseResponse instance

Creates a new case in the AWS Support Center. This operation is modeled
on the behavior of the AWS Support Center Create Case page. Its
parameters require you to specify the following information:
1. IssueType. 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."
2. ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
3. CategoryCode. The category for the service defined for the ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
4. SeverityCode. 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 DescribeSeverityLevels.
5. Subject. The Subject field on the AWS Support Center Create Case page.
6. CommunicationBody. The Description field on the AWS Support Center Create Case page.
7. AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
8. Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
9. CcEmailAddresses. The AWS Support Center CC field on the Create Case 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 AWS SDK.

To add additional communication or attachments to an existing case, use AddCommunicationToCase.

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

DescribeAttachment(AttachmentId => Str)

Each argument is described in detail in: Paws::Support::DescribeAttachment

Returns: a Paws::Support::DescribeAttachmentResponse instance

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
AttachmentDetails objects that are returned by the
DescribeCommunications operation.

DescribeCases([AfterTime => Str, BeforeTime => Str, CaseIdList => ArrayRef[Str], DisplayId => Str, IncludeCommunications => Bool, IncludeResolvedCases => Bool, Language => Str, MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::Support::DescribeCases

Returns: a Paws::Support::DescribeCasesResponse instance

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 C<AfterTime> and C<BeforeTime> request parameters. You can set
values for the C<IncludeResolvedCases> and C<IncludeCommunications>
request parameters to control how much information is returned.

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.

The response returns the following in JSON format:

1. One or more CaseDetails data types.
2. One or more NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

DescribeCommunications(CaseId => Str, [AfterTime => Str, BeforeTime => Str, MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::Support::DescribeCommunications

Returns: a Paws::Support::DescribeCommunicationsResponse instance

Returns communications (and attachments) for one or more support cases.
You can use the C<AfterTime> and C<BeforeTime> parameters to filter by
date. You can use the C<CaseId> parameter to restrict the results to a
particular 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 result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

DescribeServices([Language => Str, ServiceCodeList => ArrayRef[Str]])

Each argument is described in detail in: Paws::Support::DescribeServices

Returns: a Paws::Support::DescribeServicesResponse instance

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 CreateCase requests. Each AWS service has its own
set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices 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.

DescribeSeverityLevels([Language => Str])

Each argument is described in detail in: Paws::Support::DescribeSeverityLevels

Returns: a Paws::Support::DescribeSeverityLevelsResponse instance

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
CaseDetails data type included in any CreateCase request.

DescribeTrustedAdvisorCheckRefreshStatuses(CheckIds => ArrayRef[Str])

Each argument is described in detail in: Paws::Support::DescribeTrustedAdvisorCheckRefreshStatuses

Returns: a Paws::Support::DescribeTrustedAdvisorCheckRefreshStatusesResponse instance

Returns the refresh status of the Trusted Advisor checks that have the
specified check IDs. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks.

DescribeTrustedAdvisorCheckResult(CheckId => Str, [Language => Str])

Each argument is described in detail in: Paws::Support::DescribeTrustedAdvisorCheckResult

Returns: a Paws::Support::DescribeTrustedAdvisorCheckResultResponse instance

Returns the results of the Trusted Advisor check that has the specified
check ID. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks.

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: "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.

DescribeTrustedAdvisorChecks(Language => Str)

Each argument is described in detail in: Paws::Support::DescribeTrustedAdvisorChecks

Returns: a Paws::Support::DescribeTrustedAdvisorChecksResponse instance

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
TrustedAdvisorCheckDescription for each check.

DescribeTrustedAdvisorCheckSummaries(CheckIds => ArrayRef[Str])

Each argument is described in detail in: Paws::Support::DescribeTrustedAdvisorCheckSummaries

Returns: a Paws::Support::DescribeTrustedAdvisorCheckSummariesResponse instance

Returns the summaries of the results of the Trusted Advisor checks that
have the specified check IDs. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

RefreshTrustedAdvisorCheck(CheckId => Str)

Each argument is described in detail in: Paws::Support::RefreshTrustedAdvisorCheck

Returns: a Paws::Support::RefreshTrustedAdvisorCheckResponse instance

Requests a refresh of the Trusted Advisor check that has the specified
check ID. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

  • Status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".

  • MillisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.

  • CheckId. The unique identifier for the check.

ResolveCase([CaseId => Str])

Each argument is described in detail in: Paws::Support::ResolveCase

Returns: a Paws::Support::ResolveCaseResponse instance

Takes a C<CaseId> and returns the initial state of the case along with
the state of the case after the call to ResolveCase completed.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues