@djabry/aws-sdk-typescript
Version:
aws-sdk bindings for typescript
924 lines (828 loc) • 6.59 MB
TypeScript
// Type definitions for aws-sdk - AWS Certificate Manager
// Project: https://github.com/aws/aws-sdk-js
// Definitions by: https://github.com/ingenieux/aws-sdk-typescript
// GENERATED CODE - DO NOT EDIT
// COMMENTED <reference path="./aws-sdk.d.ts" />
declare module "aws-sdk" {
/**
* apiVersion: 2015-12-08
* endpointPrefix: acm
* serviceAbbreviation: ACM
* signatureVersion: v4
* protocol: json
*
* AWS Certificate Manager Welcome to the AWS Certificate Manager (ACM) Command
Reference. This guide provides descriptions, syntax, and usage examples for each
ACM command. You can use AWS Certificate Manager to request ACM Certificates for
your AWS-based websites and applications. For general information about using
ACM and for more information about using the console, see the AWS Certificate
Manager User Guide
[http://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html]. For more
information about using the ACM API, see the AWS Certificate Manager API
Reference [http://docs.aws.amazon.com/acm/latest/APIReference/Welcome.html].
*
*/
export class ACM extends Service {
constructor(options?: any);
endpoint: Endpoint;
/**
* Adds one or more tags to an ACM Certificate. Tags are labels that you can use to
identify and organize your AWS resources. Each tag consists of a key and an
optional value. You specify the certificate on input by its Amazon Resource Name
(ARN). You specify the tag by using a key-value pair.
You can apply a tag to just one certificate if you want to identify a specific
characteristic of that certificate, or you can apply the same tag to multiple
certificates if you want to filter for a common relationship among those
certificates. Similarly, you can apply the same tag to multiple resources if you
want to specify a relationship among those resources. For example, you can add
the same tag to an ACM Certificate and an Elastic Load Balancing load balancer
to indicate that they are both used by the same website. For more information,
see Tagging ACM Certificates
[http://docs.aws.amazon.com/acm/latest/userguide/tags.html].
To remove one or more tags, use the RemoveTagsFromCertificate action. To view
all of the tags that have been applied to the certificate, use the
ListTagsForCertificate action.
*
* @error ResourceNotFoundException
* @error InvalidArnException
* @error InvalidTagException
* @error TooManyTagsException
*/
addTagsToCertificate(params: ACM.AddTagsToCertificateRequest, callback?: (err: ACM.ResourceNotFoundException|ACM.InvalidArnException|ACM.InvalidTagException|ACM.TooManyTagsException|any, data: any) => void): Request<any,ACM.ResourceNotFoundException|ACM.InvalidArnException|ACM.InvalidTagException|ACM.TooManyTagsException|any>;
/**
* Deletes an ACM Certificate and its associated private key. If this action
succeeds, the certificate no longer appears in the list of ACM Certificates that
can be displayed by calling the ListCertificates action or be retrieved by
calling the GetCertificate action. The certificate will not be available for use
by other AWS services.
You cannot delete an ACM Certificate that is being used by another AWS service.
To delete a certificate that is in use, the certificate association must first
be removed.
*
* @error ResourceNotFoundException
* @error ResourceInUseException
* @error InvalidArnException
*/
deleteCertificate(params: ACM.DeleteCertificateRequest, callback?: (err: ACM.ResourceNotFoundException|ACM.ResourceInUseException|ACM.InvalidArnException|any, data: any) => void): Request<any,ACM.ResourceNotFoundException|ACM.ResourceInUseException|ACM.InvalidArnException|any>;
/**
* Returns a list of the fields contained in the specified ACM Certificate. For
example, this action returns the certificate status, a flag that indicates
whether the certificate is associated with any other AWS service, and the date
at which the certificate request was created. You specify the ACM Certificate on
input by its Amazon Resource Name (ARN).
*
* @error ResourceNotFoundException
* @error InvalidArnException
*/
describeCertificate(params: ACM.DescribeCertificateRequest, callback?: (err: ACM.ResourceNotFoundException|ACM.InvalidArnException|any, data: ACM.DescribeCertificateResponse|any) => void): Request<ACM.DescribeCertificateResponse|any,ACM.ResourceNotFoundException|ACM.InvalidArnException|any>;
/**
* Retrieves an ACM Certificate and certificate chain for the certificate specified
by an ARN. The chain is an ordered list of certificates that contains the root
certificate, intermediate certificates of subordinate CAs, and the ACM
Certificate. The certificate and certificate chain are base64 encoded. If you
want to decode the certificate chain to see the individual certificate fields,
you can use OpenSSL.
Currently, ACM Certificates can be used only with Elastic Load Balancing and
Amazon CloudFront.
*
* @error ResourceNotFoundException
* @error RequestInProgressException
* @error InvalidArnException
*/
getCertificate(params: ACM.GetCertificateRequest, callback?: (err: ACM.ResourceNotFoundException|ACM.RequestInProgressException|ACM.InvalidArnException|any, data: ACM.GetCertificateResponse|any) => void): Request<ACM.GetCertificateResponse|any,ACM.ResourceNotFoundException|ACM.RequestInProgressException|ACM.InvalidArnException|any>;
/**
* Retrieves a list of ACM Certificates and the domain name for each. You can
optionally filter the list to return only the certificates that match the
specified status.
*
*/
listCertificates(params: ACM.ListCertificatesRequest, callback?: (err: any, data: ACM.ListCertificatesResponse|any) => void): Request<ACM.ListCertificatesResponse|any,any>;
/**
* Lists the tags that have been applied to the ACM Certificate. Use the
certificate ARN to specify the certificate. To add a tag to an ACM Certificate,
use the AddTagsToCertificate action. To delete a tag, use the
RemoveTagsFromCertificate action.
*
* @error ResourceNotFoundException
* @error InvalidArnException
*/
listTagsForCertificate(params: ACM.ListTagsForCertificateRequest, callback?: (err: ACM.ResourceNotFoundException|ACM.InvalidArnException|any, data: ACM.ListTagsForCertificateResponse|any) => void): Request<ACM.ListTagsForCertificateResponse|any,ACM.ResourceNotFoundException|ACM.InvalidArnException|any>;
/**
* Remove one or more tags from an ACM Certificate. A tag consists of a key-value
pair. If you do not specify the value portion of the tag when calling this
function, the tag will be removed regardless of value. If you specify a value,
the tag is removed only if it is associated with the specified value.
To add tags to a certificate, use the AddTagsToCertificate action. To view all
of the tags that have been applied to a specific ACM Certificate, use the
ListTagsForCertificate action.
*
* @error ResourceNotFoundException
* @error InvalidArnException
* @error InvalidTagException
*/
removeTagsFromCertificate(params: ACM.RemoveTagsFromCertificateRequest, callback?: (err: ACM.ResourceNotFoundException|ACM.InvalidArnException|ACM.InvalidTagException|any, data: any) => void): Request<any,ACM.ResourceNotFoundException|ACM.InvalidArnException|ACM.InvalidTagException|any>;
/**
* Requests an ACM Certificate for use with other AWS services. To request an ACM
Certificate, you must specify the fully qualified domain name (FQDN) for your
site. You can also specify additional FQDNs if users can reach your site by
using other names. For each domain name you specify, email is sent to the domain
owner to request approval to issue the certificate. After receiving approval
from the domain owner, the ACM Certificate is issued. For more information, see
the AWS Certificate Manager User Guide
[http://docs.aws.amazon.com/acm/latest/userguide/overview.html].
*
* @error LimitExceededException
* @error InvalidDomainValidationOptionsException
*/
requestCertificate(params: ACM.RequestCertificateRequest, callback?: (err: ACM.LimitExceededException|ACM.InvalidDomainValidationOptionsException|any, data: ACM.RequestCertificateResponse|any) => void): Request<ACM.RequestCertificateResponse|any,ACM.LimitExceededException|ACM.InvalidDomainValidationOptionsException|any>;
/**
* Resends the email that requests domain ownership validation. The domain owner or
an authorized representative must approve the ACM Certificate before it can be
issued. The certificate can be approved by clicking a link in the mail to
navigate to the Amazon certificate approval website and then clicking I Approve.
However, the validation email can be blocked by spam filters. Therefore, if you
do not receive the original mail, you can request that the mail be resent within
72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed
since your original request or since your last attempt to resend validation
mail, you must request a new certificate.
*
* @error ResourceNotFoundException
* @error InvalidStateException
* @error InvalidArnException
* @error InvalidDomainValidationOptionsException
*/
resendValidationEmail(params: ACM.ResendValidationEmailRequest, callback?: (err: ACM.ResourceNotFoundException|ACM.InvalidStateException|ACM.InvalidArnException|ACM.InvalidDomainValidationOptionsException|any, data: any) => void): Request<any,ACM.ResourceNotFoundException|ACM.InvalidStateException|ACM.InvalidArnException|ACM.InvalidDomainValidationOptionsException|any>;
}
export module ACM {
export type Arn = string;
export type CertificateBody = string;
export type CertificateChain = string;
export type CertificateStatus = string;
export type CertificateStatuses = CertificateStatus[];
export type CertificateSummaryList = CertificateSummary[];
export type DomainList = DomainNameString[];
export type DomainNameString = string;
export type DomainValidationList = DomainValidation[];
export type DomainValidationOptionList = DomainValidationOption[];
export type FailureReason = string;
export type IdempotencyToken = string;
export type InUseList = String[];
export type KeyAlgorithm = string;
export type MaxItems = number;
export type NextToken = string;
export type RevocationReason = string;
export type String = string;
export type TStamp = number;
export type TagKey = string;
export type TagList = Tag[];
export type TagValue = string;
export type ValidationEmailList = String[];
export interface AddTagsToCertificateRequest {
/** String that contains the ARN of the ACM Certificate to which the tag is to be
applied. This must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
Service Namespaces
[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html]. **/
CertificateArn: Arn;
/** The key-value pair that defines the tag. The tag value is optional. **/
Tags: TagList;
}
export interface CertificateDetail {
/** The Amazon Resource Name (ARN) of the certificate. For more information about
ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces
[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html]. **/
CertificateArn?: Arn;
/** The fully qualified domain name (FQDN) for the certificate, such as
www.example.com or example.com. **/
DomainName?: DomainNameString;
/** One or more domain names (subject alternative names) included in the certificate
request. After the certificate is issued, this list includes the domain names
bound to the public key contained in the certificate. The subject alternative
names include the canonical domain name (CN) of the certificate and additional
domain names that can be used to connect to the website. **/
SubjectAlternativeNames?: DomainList;
/** Contains information about the email address or addresses used for domain
validation. **/
DomainValidationOptions?: DomainValidationList;
/** The serial number of the certificate. **/
Serial?: String;
/** The X.500 distinguished name of the entity associated with the public key
contained in the certificate. **/
Subject?: String;
/** The X.500 distinguished name of the CA that issued and signed the certificate. **/
Issuer?: String;
/** The time at which the certificate was requested. **/
CreatedAt?: TStamp;
/** The time at which the certificate was issued. **/
IssuedAt?: TStamp;
/** The status of the certificate. **/
Status?: CertificateStatus;
/** The time at which the certificate was revoked. This value exists only when the
certificate status is REVOKED. **/
RevokedAt?: TStamp;
/** The reason the certificate was revoked. This value exists only when the
certificate status is REVOKED. **/
RevocationReason?: RevocationReason;
/** The time before which the certificate is not valid. **/
NotBefore?: TStamp;
/** The time after which the certificate is not valid. **/
NotAfter?: TStamp;
/** The algorithm used to generate the key pair (the public and private key).
Currently the only supported value is RSA_2048. **/
KeyAlgorithm?: KeyAlgorithm;
/** The algorithm used to generate a signature. Currently the only supported value
is SHA256WITHRSA. **/
SignatureAlgorithm?: String;
/** A list of ARNs for the resources that are using the certificate. An ACM
Certificate can be used by multiple AWS resources. **/
InUseBy?: InUseList;
/** The reason the certificate request failed. This value exists only when the
structure's Status is FAILED. For more information, see Certificate Request
Failed
[http://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed]
in the AWS Certificate Manager User Guide. **/
FailureReason?: FailureReason;
}
export interface CertificateSummary {
/** Amazon Resource Name (ARN) of the certificate. This is of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
Service Namespaces
[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html]. **/
CertificateArn?: Arn;
/** Fully qualified domain name (FQDN), such as www.example.com or example.com, for
the certificate. **/
DomainName?: DomainNameString;
}
export interface DeleteCertificateRequest {
/** String that contains the ARN of the ACM Certificate to be deleted. This must be
of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
Service Namespaces
[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html]. **/
CertificateArn: Arn;
}
export interface DescribeCertificateRequest {
/** String that contains an ACM Certificate ARN. The ARN must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
Service Namespaces
[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html]. **/
CertificateArn: Arn;
}
export interface DescribeCertificateResponse {
/** Contains a CertificateDetail structure that lists the fields of an ACM
Certificate. **/
Certificate?: CertificateDetail;
}
export interface DomainValidation {
/** Fully Qualified Domain Name (FQDN) of the form www.example.com or example.com. **/
DomainName: DomainNameString;
/** A list of contact address for the domain registrant. **/
ValidationEmails?: ValidationEmailList;
/** The base validation domain that acts as the suffix of the email addresses that
are used to send the emails. **/
ValidationDomain?: DomainNameString;
}
export interface DomainValidationOption {
/** Fully Qualified Domain Name (FQDN) of the certificate being requested. **/
DomainName: DomainNameString;
/** The domain to which validation email is sent. This is the base validation domain
that will act as the suffix of the email addresses. This must be the same as the
DomainName value or a superdomain of the DomainName value. For example, if you
requested a certificate for site.subdomain.example.com and specify a
ValidationDomain of subdomain.example.com, ACM sends email to the domain
registrant, technical contact, and administrative contact in WHOIS for the base
domain and the following five addresses:
&#42; admin@subdomain.example.com
&#42; administrator@subdomain.example.com
&#42; hostmaster@subdomain.example.com
&#42; postmaster@subdomain.example.com
&#42; webmaster@subdomain.example.com **/
ValidationDomain: DomainNameString;
}
export interface GetCertificateRequest {
/** String that contains a certificate ARN in the following format:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
Service Namespaces
[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html]. **/
CertificateArn: Arn;
}
export interface GetCertificateResponse {
/** String that contains the ACM Certificate represented by the ARN specified at
input. **/
Certificate?: CertificateBody;
/** The certificate chain that contains the root certificate issued by the
certificate authority (CA). **/
CertificateChain?: CertificateChain;
}
export interface InvalidArnException {
message?: String;
}
export interface InvalidDomainValidationOptionsException {
message?: String;
}
export interface InvalidStateException {
message?: String;
}
export interface InvalidTagException {
message?: String;
}
export interface LimitExceededException {
message?: String;
}
export interface ListCertificatesRequest {
/** The status or statuses on which to filter the list of ACM Certificates. **/
CertificateStatuses?: CertificateStatuses;
/** Use this parameter only when paginating results and only in a subsequent request
after you receive a response with truncated results. Set it to the value of
NextToken from the response you just received. **/
NextToken?: NextToken;
/** Use this parameter when paginating results to specify the maximum number of
items to return in the response. If additional items exist beyond the number you
specify, the NextToken element is sent in the response. Use this NextToken value
in a subsequent request to retrieve additional items. **/
MaxItems?: MaxItems;
}
export interface ListCertificatesResponse {
/** When the list is truncated, this value is present and contains the value to use
for the NextToken parameter in a subsequent pagination request. **/
NextToken?: NextToken;
/** A list of ACM Certificates. **/
CertificateSummaryList?: CertificateSummaryList;
}
export interface ListTagsForCertificateRequest {
/** String that contains the ARN of the ACM Certificate for which you want to list
the tags. This must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
Service Namespaces
[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html]. **/
CertificateArn: Arn;
}
export interface ListTagsForCertificateResponse {
/** The key-value pairs that define the applied tags. **/
Tags?: TagList;
}
export interface RemoveTagsFromCertificateRequest {
/** String that contains the ARN of the ACM Certificate with one or more tags that
you want to remove. This must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
Service Namespaces
[http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html]. **/
CertificateArn: Arn;
/** The key-value pair that defines the tag to remove. **/
Tags: TagList;
}
export interface RequestCertificateRequest {
/** Fully qualified domain name (FQDN), such as www.example.com, of the site you
want to secure with an ACM Certificate. Use an asterisk (&#42;) to create a wildcard
certificate that protects several sites in the same domain. For example,
&#42;.example.com protects www.example.com, site.example.com, and
images.example.com. **/
DomainName: DomainNameString;
/** Additional FQDNs to be included in the Subject Alternative Name extension of the
ACM Certificate. For example, add the name www.example.net to a certificate for
which the DomainName field is www.example.com if users can reach your site by
using either name. **/
SubjectAlternativeNames?: DomainList;
/** Customer chosen string that can be used to distinguish between calls to
RequestCertificate. Idempotency tokens time out after one hour. Therefore, if
you call RequestCertificate multiple times with the same idempotency token
within one hour, ACM recognizes that you are requesting only one certificate and
will issue only one. If you change the idempotency token for each call, ACM
recognizes that you are requesting multiple certificates. **/
IdempotencyToken?: IdempotencyToken;
/** The base validation domain that will act as the suffix of the email addresses
that are used to send the emails. This must be the same as the Domain value or a
superdomain of the Domain value. For example, if you requested a certificate for
test.example.com and specify DomainValidationOptions of example.com, ACM sends
email to the domain registrant, technical contact, and administrative contact in
WHOIS and the following five addresses:
&#42; admin@example.com
&#42; administrator@example.com
&#42; hostmaster@example.com
&#42; postmaster@example.com
&#42; webmaster@example.com **/
DomainValidationOptions?: DomainValidationOptionList;
}
export interface RequestCertificateResponse {
/** String that contains the ARN of the issued certificate. This must be of the
form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 **/
CertificateArn?: Arn;
}
export interface RequestInProgressException {
message?: String;
}
export interface ResendValidationEmailRequest {
/** String that contains the ARN of the requested certificate. The certificate ARN
is generated and returned by the RequestCertificate action as soon as the
request is made. By default, using this parameter causes email to be sent to all
top-level domains you specified in the certificate request.
The ARN must be of the form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 **/
CertificateArn: Arn;
/** The Fully Qualified Domain Name (FQDN) of the certificate that needs to be
validated. **/
Domain: DomainNameString;
/** The base validation domain that will act as the suffix of the email addresses
that are used to send the emails. This must be the same as the Domain value or a
superdomain of the Domain value. For example, if you requested a certificate for
site.subdomain.example.com and specify a ValidationDomain of
subdomain.example.com, ACM sends email to the domain registrant, technical
contact, and administrative contact in WHOIS and the following five addresses:
&#42; admin@subdomain.example.com
&#42; administrator@subdomain.example.com
&#42; hostmaster@subdomain.example.com
&#42; postmaster@subdomain.example.com
&#42; webmaster@subdomain.example.com **/
ValidationDomain: DomainNameString;
}
export interface ResourceInUseException {
message?: String;
}
export interface ResourceNotFoundException {
message?: String;
}
export interface Tag {
/** The key of the tag. **/
Key: TagKey;
/** The value of the tag. **/
Value?: TagValue;
}
export interface TooManyTagsException {
message?: String;
}
}
}
// Type definitions for aws-sdk - Amazon API Gateway
// Project: https://github.com/aws/aws-sdk-js
// Definitions by: https://github.com/ingenieux/aws-sdk-typescript
// GENERATED CODE - DO NOT EDIT
// COMMENTED <reference path="./aws-sdk.d.ts" />
declare module "aws-sdk" {
/**
* apiVersion: 2015-07-09
* endpointPrefix: apigateway
* serviceAbbreviation:
* signatureVersion: v4
* protocol: rest-json
*
* Amazon API Gateway Amazon API Gateway helps developers deliver robust, secure,
and scalable mobile and web application back ends. Amazon API Gateway allows
developers to securely connect mobile and web applications to APIs that run on
AWS Lambda, Amazon EC2, or other publicly addressable web services that are
hosted outside of AWS.
*
*/
export class APIGateway extends Service {
constructor(options?: any);
endpoint: Endpoint;
/**
* Create an ApiKey resource.
AWS CLI
[http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html]
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error LimitExceededException
* @error BadRequestException
* @error ConflictException
*/
createApiKey(params: APIGateway.CreateApiKeyRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.LimitExceededException|APIGateway.BadRequestException|APIGateway.ConflictException|any, data: APIGateway.ApiKey|any) => void): Request<APIGateway.ApiKey|any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.LimitExceededException|APIGateway.BadRequestException|APIGateway.ConflictException|any>;
/**
* Adds a new Authorizer resource to an existing RestApi resource.
AWS CLI
[http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html]
*
* @error BadRequestException
* @error UnauthorizedException
* @error NotFoundException
* @error LimitExceededException
* @error TooManyRequestsException
*/
createAuthorizer(params: APIGateway.CreateAuthorizerRequest, callback?: (err: APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.LimitExceededException|APIGateway.TooManyRequestsException|any, data: APIGateway.Authorizer|any) => void): Request<APIGateway.Authorizer|any,APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.LimitExceededException|APIGateway.TooManyRequestsException|any>;
/**
* Creates a new BasePathMapping resource.
*
* @error UnauthorizedException
* @error ConflictException
* @error BadRequestException
* @error NotFoundException
* @error TooManyRequestsException
*/
createBasePathMapping(params: APIGateway.CreateBasePathMappingRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.ConflictException|APIGateway.BadRequestException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: APIGateway.BasePathMapping|any) => void): Request<APIGateway.BasePathMapping|any,APIGateway.UnauthorizedException|APIGateway.ConflictException|APIGateway.BadRequestException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Creates a Deployment resource, which makes a specified RestApi callable over the
internet.
*
* @error UnauthorizedException
* @error BadRequestException
* @error NotFoundException
* @error ConflictException
* @error LimitExceededException
* @error TooManyRequestsException
* @error ServiceUnavailableException
*/
createDeployment(params: APIGateway.CreateDeploymentRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.BadRequestException|APIGateway.NotFoundException|APIGateway.ConflictException|APIGateway.LimitExceededException|APIGateway.TooManyRequestsException|APIGateway.ServiceUnavailableException|any, data: APIGateway.Deployment|any) => void): Request<APIGateway.Deployment|any,APIGateway.UnauthorizedException|APIGateway.BadRequestException|APIGateway.NotFoundException|APIGateway.ConflictException|APIGateway.LimitExceededException|APIGateway.TooManyRequestsException|APIGateway.ServiceUnavailableException|any>;
/**
* Creates a new domain name.
*
* @error UnauthorizedException
* @error BadRequestException
* @error ConflictException
* @error TooManyRequestsException
*/
createDomainName(params: APIGateway.CreateDomainNameRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.BadRequestException|APIGateway.ConflictException|APIGateway.TooManyRequestsException|any, data: APIGateway.DomainName|any) => void): Request<APIGateway.DomainName|any,APIGateway.UnauthorizedException|APIGateway.BadRequestException|APIGateway.ConflictException|APIGateway.TooManyRequestsException|any>;
/**
* Adds a new Model resource to an existing RestApi resource.
*
* @error BadRequestException
* @error UnauthorizedException
* @error NotFoundException
* @error ConflictException
* @error LimitExceededException
* @error TooManyRequestsException
*/
createModel(params: APIGateway.CreateModelRequest, callback?: (err: APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.ConflictException|APIGateway.LimitExceededException|APIGateway.TooManyRequestsException|any, data: APIGateway.Model|any) => void): Request<APIGateway.Model|any,APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.ConflictException|APIGateway.LimitExceededException|APIGateway.TooManyRequestsException|any>;
/**
* Creates a Resource resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error ConflictException
* @error LimitExceededException
* @error BadRequestException
* @error TooManyRequestsException
*/
createResource(params: APIGateway.CreateResourceRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.ConflictException|APIGateway.LimitExceededException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any, data: APIGateway.Resource|any) => void): Request<APIGateway.Resource|any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.ConflictException|APIGateway.LimitExceededException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any>;
/**
* Creates a new RestApi resource.
*
* @error UnauthorizedException
* @error LimitExceededException
* @error BadRequestException
* @error TooManyRequestsException
*/
createRestApi(params: APIGateway.CreateRestApiRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.LimitExceededException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any, data: APIGateway.RestApi|any) => void): Request<APIGateway.RestApi|any,APIGateway.UnauthorizedException|APIGateway.LimitExceededException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any>;
/**
* Creates a new Stage resource that references a pre-existing Deployment for the
API.
*
* @error UnauthorizedException
* @error BadRequestException
* @error NotFoundException
* @error ConflictException
* @error LimitExceededException
* @error TooManyRequestsException
*/
createStage(params: APIGateway.CreateStageRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.BadRequestException|APIGateway.NotFoundException|APIGateway.ConflictException|APIGateway.LimitExceededException|APIGateway.TooManyRequestsException|any, data: APIGateway.Stage|any) => void): Request<APIGateway.Stage|any,APIGateway.UnauthorizedException|APIGateway.BadRequestException|APIGateway.NotFoundException|APIGateway.ConflictException|APIGateway.LimitExceededException|APIGateway.TooManyRequestsException|any>;
/**
* Creates a usage plan with the throttle and quota limits, as well as the
associated API stages, specified in the payload.
*
* @error BadRequestException
* @error UnauthorizedException
* @error TooManyRequestsException
* @error LimitExceededException
* @error ConflictException
*/
createUsagePlan(params: APIGateway.CreateUsagePlanRequest, callback?: (err: APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|APIGateway.LimitExceededException|APIGateway.ConflictException|any, data: APIGateway.UsagePlan|any) => void): Request<APIGateway.UsagePlan|any,APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|APIGateway.LimitExceededException|APIGateway.ConflictException|any>;
/**
* Creates a usage plan key for adding an existing API key to a usage plan.
*
* @error BadRequestException
* @error ConflictException
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
createUsagePlanKey(params: APIGateway.CreateUsagePlanKeyRequest, callback?: (err: APIGateway.BadRequestException|APIGateway.ConflictException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: APIGateway.UsagePlanKey|any) => void): Request<APIGateway.UsagePlanKey|any,APIGateway.BadRequestException|APIGateway.ConflictException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Deletes the ApiKey resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
deleteApiKey(params: APIGateway.DeleteApiKeyRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Deletes an existing Authorizer resource.
AWS CLI
[http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html]
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error BadRequestException
* @error ConflictException
*/
deleteAuthorizer(params: APIGateway.DeleteAuthorizerRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.ConflictException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.ConflictException|any>;
/**
* Deletes the BasePathMapping resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
deleteBasePathMapping(params: APIGateway.DeleteBasePathMappingRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Deletes the ClientCertificate resource.
*
* @error UnauthorizedException
* @error TooManyRequestsException
* @error BadRequestException
* @error NotFoundException
*/
deleteClientCertificate(params: APIGateway.DeleteClientCertificateRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.NotFoundException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.NotFoundException|any>;
/**
* Deletes a Deployment resource. Deleting a deployment will only succeed if there
are no Stage resources associated with it.
*
* @error UnauthorizedException
* @error NotFoundException
* @error BadRequestException
* @error TooManyRequestsException
*/
deleteDeployment(params: APIGateway.DeleteDeploymentRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any>;
/**
* Deletes the DomainName resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
deleteDomainName(params: APIGateway.DeleteDomainNameRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Represents a delete integration.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error ConflictException
*/
deleteIntegration(params: APIGateway.DeleteIntegrationRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.ConflictException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.ConflictException|any>;
/**
* Represents a delete integration response.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error BadRequestException
* @error ConflictException
*/
deleteIntegrationResponse(params: APIGateway.DeleteIntegrationResponseRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.ConflictException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.ConflictException|any>;
/**
* Deletes an existing Method resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error ConflictException
*/
deleteMethod(params: APIGateway.DeleteMethodRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.ConflictException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.ConflictException|any>;
/**
* Deletes an existing MethodResponse resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error BadRequestException
* @error ConflictException
*/
deleteMethodResponse(params: APIGateway.DeleteMethodResponseRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.ConflictException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.ConflictException|any>;
/**
* Deletes a model.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error BadRequestException
* @error ConflictException
*/
deleteModel(params: APIGateway.DeleteModelRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.ConflictException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.ConflictException|any>;
/**
* Deletes a Resource resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error BadRequestException
* @error ConflictException
* @error TooManyRequestsException
*/
deleteResource(params: APIGateway.DeleteResourceRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.BadRequestException|APIGateway.ConflictException|APIGateway.TooManyRequestsException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.BadRequestException|APIGateway.ConflictException|APIGateway.TooManyRequestsException|any>;
/**
* Deletes the specified API.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error BadRequestException
*/
deleteRestApi(params: APIGateway.DeleteRestApiRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|any>;
/**
* Deletes a Stage resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
* @error BadRequestException
*/
deleteStage(params: APIGateway.DeleteStageRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|any>;
/**
* Deletes a usage plan of a given plan Id.
*
* @error UnauthorizedException
* @error TooManyRequestsException
* @error BadRequestException
* @error NotFoundException
*/
deleteUsagePlan(params: APIGateway.DeleteUsagePlanRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.NotFoundException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|APIGateway.BadRequestException|APIGateway.NotFoundException|any>;
/**
* Deletes a usage plan key and remove the underlying API key from the associated
usage plan.
*
* @error BadRequestException
* @error ConflictException
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
deleteUsagePlanKey(params: APIGateway.DeleteUsagePlanKeyRequest, callback?: (err: APIGateway.BadRequestException|APIGateway.ConflictException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: any) => void): Request<any,APIGateway.BadRequestException|APIGateway.ConflictException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Flushes all authorizer cache entries on a stage.
*
* @error UnauthorizedException
* @error NotFoundException
* @error BadRequestException
* @error TooManyRequestsException
*/
flushStageAuthorizersCache(params: APIGateway.FlushStageAuthorizersCacheRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any>;
/**
* Flushes a stage's cache.
*
* @error UnauthorizedException
* @error NotFoundException
* @error BadRequestException
* @error TooManyRequestsException
*/
flushStageCache(params: APIGateway.FlushStageCacheRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any, data: any) => void): Request<any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.BadRequestException|APIGateway.TooManyRequestsException|any>;
/**
* Generates a ClientCertificate resource.
*
* @error UnauthorizedException
* @error TooManyRequestsException
* @error LimitExceededException
*/
generateClientCertificate(params: APIGateway.GenerateClientCertificateRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|APIGateway.LimitExceededException|any, data: APIGateway.ClientCertificate|any) => void): Request<APIGateway.ClientCertificate|any,APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|APIGateway.LimitExceededException|any>;
/**
* Gets information about the current Account resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
getAccount(params: APIGateway.GetAccountRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: APIGateway.Account|any) => void): Request<APIGateway.Account|any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Gets information about the current ApiKey resource.
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
getApiKey(params: APIGateway.GetApiKeyRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: APIGateway.ApiKey|any) => void): Request<APIGateway.ApiKey|any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Gets information about the current ApiKeys resource.
*
* @error BadRequestException
* @error UnauthorizedException
* @error TooManyRequestsException
*/
getApiKeys(params: APIGateway.GetApiKeysRequest, callback?: (err: APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|any, data: APIGateway.ApiKeys|any) => void): Request<APIGateway.ApiKeys|any,APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.TooManyRequestsException|any>;
/**
* Describe an existing Authorizer resource.
AWS CLI
[http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html]
*
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
getAuthorizer(params: APIGateway.GetAuthorizerRequest, callback?: (err: APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: APIGateway.Authorizer|any) => void): Request<APIGateway.Authorizer|any,APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any>;
/**
* Describe an existing Authorizers resource.
AWS CLI
[http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html]
*
* @error BadRequestException
* @error UnauthorizedException
* @error NotFoundException
* @error TooManyRequestsException
*/
getAuthorizers(params: APIGateway.GetAuthorizersRequest, callback?: (err: APIGateway.BadRequestException|APIGateway.UnauthorizedException|APIGateway.NotFoundException|APIGateway.TooManyRequestsException|any, data: APIGateway.Authorizers|any) => void): Request<APIGateway.Authoriz