Backend half

This commit is contained in:
2025-07-11 19:56:28 +02:00
parent fa868e7c1d
commit 8600fa7c1d
19426 changed files with 3750448 additions and 8108 deletions
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['accessanalyzer'] = {};
AWS.AccessAnalyzer = Service.defineService('accessanalyzer', ['2019-11-01']);
Object.defineProperty(apiLoader.services['accessanalyzer'], '2019-11-01', {
get: function get() {
var model = require('../apis/accessanalyzer-2019-11-01.min.json');
model.paginators = require('../apis/accessanalyzer-2019-11-01.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AccessAnalyzer;
+426
View File
@@ -0,0 +1,426 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Account extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Account.Types.ClientConfiguration)
config: Config & Account.Types.ClientConfiguration;
/**
* Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.
*/
acceptPrimaryEmailUpdate(params: Account.Types.AcceptPrimaryEmailUpdateRequest, callback?: (err: AWSError, data: Account.Types.AcceptPrimaryEmailUpdateResponse) => void): Request<Account.Types.AcceptPrimaryEmailUpdateResponse, AWSError>;
/**
* Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.
*/
acceptPrimaryEmailUpdate(callback?: (err: AWSError, data: Account.Types.AcceptPrimaryEmailUpdateResponse) => void): Request<Account.Types.AcceptPrimaryEmailUpdateResponse, AWSError>;
/**
* Deletes the specified alternate contact from an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts. Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
*/
deleteAlternateContact(params: Account.Types.DeleteAlternateContactRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified alternate contact from an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts. Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
*/
deleteAlternateContact(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disables (opts-out) a particular Region for an account. The act of disabling a Region will remove all IAM access to any resources that reside in that Region.
*/
disableRegion(params: Account.Types.DisableRegionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disables (opts-out) a particular Region for an account. The act of disabling a Region will remove all IAM access to any resources that reside in that Region.
*/
disableRegion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables (opts-in) a particular Region for an account.
*/
enableRegion(params: Account.Types.EnableRegionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables (opts-in) a particular Region for an account.
*/
enableRegion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves the specified alternate contact attached to an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts. Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
*/
getAlternateContact(params: Account.Types.GetAlternateContactRequest, callback?: (err: AWSError, data: Account.Types.GetAlternateContactResponse) => void): Request<Account.Types.GetAlternateContactResponse, AWSError>;
/**
* Retrieves the specified alternate contact attached to an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts. Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
*/
getAlternateContact(callback?: (err: AWSError, data: Account.Types.GetAlternateContactResponse) => void): Request<Account.Types.GetAlternateContactResponse, AWSError>;
/**
* Retrieves the primary contact information of an Amazon Web Services account. For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
*/
getContactInformation(params: Account.Types.GetContactInformationRequest, callback?: (err: AWSError, data: Account.Types.GetContactInformationResponse) => void): Request<Account.Types.GetContactInformationResponse, AWSError>;
/**
* Retrieves the primary contact information of an Amazon Web Services account. For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
*/
getContactInformation(callback?: (err: AWSError, data: Account.Types.GetContactInformationResponse) => void): Request<Account.Types.GetContactInformationResponse, AWSError>;
/**
* Retrieves the primary email address for the specified account.
*/
getPrimaryEmail(params: Account.Types.GetPrimaryEmailRequest, callback?: (err: AWSError, data: Account.Types.GetPrimaryEmailResponse) => void): Request<Account.Types.GetPrimaryEmailResponse, AWSError>;
/**
* Retrieves the primary email address for the specified account.
*/
getPrimaryEmail(callback?: (err: AWSError, data: Account.Types.GetPrimaryEmailResponse) => void): Request<Account.Types.GetPrimaryEmailResponse, AWSError>;
/**
* Retrieves the opt-in status of a particular Region.
*/
getRegionOptStatus(params: Account.Types.GetRegionOptStatusRequest, callback?: (err: AWSError, data: Account.Types.GetRegionOptStatusResponse) => void): Request<Account.Types.GetRegionOptStatusResponse, AWSError>;
/**
* Retrieves the opt-in status of a particular Region.
*/
getRegionOptStatus(callback?: (err: AWSError, data: Account.Types.GetRegionOptStatusResponse) => void): Request<Account.Types.GetRegionOptStatusResponse, AWSError>;
/**
* Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains parameter.
*/
listRegions(params: Account.Types.ListRegionsRequest, callback?: (err: AWSError, data: Account.Types.ListRegionsResponse) => void): Request<Account.Types.ListRegionsResponse, AWSError>;
/**
* Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains parameter.
*/
listRegions(callback?: (err: AWSError, data: Account.Types.ListRegionsResponse) => void): Request<Account.Types.ListRegionsResponse, AWSError>;
/**
* Modifies the specified alternate contact attached to an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts. Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
*/
putAlternateContact(params: Account.Types.PutAlternateContactRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Modifies the specified alternate contact attached to an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts. Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
*/
putAlternateContact(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the primary contact information of an Amazon Web Services account. For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
*/
putContactInformation(params: Account.Types.PutContactInformationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the primary contact information of an Amazon Web Services account. For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
*/
putContactInformation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Starts the process to update the primary email address for the specified account.
*/
startPrimaryEmailUpdate(params: Account.Types.StartPrimaryEmailUpdateRequest, callback?: (err: AWSError, data: Account.Types.StartPrimaryEmailUpdateResponse) => void): Request<Account.Types.StartPrimaryEmailUpdateResponse, AWSError>;
/**
* Starts the process to update the primary email address for the specified account.
*/
startPrimaryEmailUpdate(callback?: (err: AWSError, data: Account.Types.StartPrimaryEmailUpdateResponse) => void): Request<Account.Types.StartPrimaryEmailUpdateResponse, AWSError>;
}
declare namespace Account {
export interface AcceptPrimaryEmailUpdateRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. The management account can't specify its own AccountId.
*/
AccountId: AccountId;
/**
* The OTP code sent to the PrimaryEmail specified on the StartPrimaryEmailUpdate API call.
*/
Otp: Otp;
/**
* The new primary email address for use with the specified account. This must match the PrimaryEmail from the StartPrimaryEmailUpdate API call.
*/
PrimaryEmail: PrimaryEmailAddress;
}
export interface AcceptPrimaryEmailUpdateResponse {
/**
* Retrieves the status of the accepted primary email update request.
*/
Status?: PrimaryEmailUpdateStatus;
}
export type AccountId = string;
export type AddressLine = string;
export interface AlternateContact {
/**
* The type of alternate contact.
*/
AlternateContactType?: AlternateContactType;
/**
* The email address associated with this alternate contact.
*/
EmailAddress?: EmailAddress;
/**
* The name associated with this alternate contact.
*/
Name?: Name;
/**
* The phone number associated with this alternate contact.
*/
PhoneNumber?: PhoneNumber;
/**
* The title associated with this alternate contact.
*/
Title?: Title;
}
export type AlternateContactType = "BILLING"|"OPERATIONS"|"SECURITY"|string;
export type City = string;
export type CompanyName = string;
export interface ContactInformation {
/**
* The first line of the primary contact address.
*/
AddressLine1: AddressLine;
/**
* The second line of the primary contact address, if any.
*/
AddressLine2?: AddressLine;
/**
* The third line of the primary contact address, if any.
*/
AddressLine3?: AddressLine;
/**
* The city of the primary contact address.
*/
City: City;
/**
* The name of the company associated with the primary contact information, if any.
*/
CompanyName?: CompanyName;
/**
* The ISO-3166 two-letter country code for the primary contact address.
*/
CountryCode: CountryCode;
/**
* The district or county of the primary contact address, if any.
*/
DistrictOrCounty?: DistrictOrCounty;
/**
* The full name of the primary contact address.
*/
FullName: FullName;
/**
* The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
*/
PhoneNumber: ContactInformationPhoneNumber;
/**
* The postal code of the primary contact address.
*/
PostalCode: PostalCode;
/**
* The state or region of the primary contact address. If the mailing address is within the United States (US), the value in this field can be either a two character state code (for example, NJ) or the full state name (for example, New Jersey). This field is required in the following countries: US, CA, GB, DE, JP, IN, and BR.
*/
StateOrRegion?: StateOrRegion;
/**
* The URL of the website associated with the primary contact information, if any.
*/
WebsiteUrl?: WebsiteUrl;
}
export type ContactInformationPhoneNumber = string;
export type CountryCode = string;
export interface DeleteAlternateContactRequest {
/**
* Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
/**
* Specifies which of the alternate contacts to delete.
*/
AlternateContactType: AlternateContactType;
}
export interface DisableRegionRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
/**
* Specifies the Region-code for a given Region name (for example, af-south-1). When you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such as destroying IAM resources in the Region. This process takes a few minutes for most accounts, but this can take several hours. You cannot enable the Region until the disabling process is fully completed.
*/
RegionName: RegionName;
}
export type DistrictOrCounty = string;
export type EmailAddress = string;
export interface EnableRegionRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
/**
* Specifies the Region-code for a given Region name (for example, af-south-1). When you enable a Region, Amazon Web Services performs actions to prepare your account in that Region, such as distributing your IAM resources to the Region. This process takes a few minutes for most accounts, but it can take several hours. You cannot use the Region until this process is complete. Furthermore, you cannot disable the Region until the enabling process is fully completed.
*/
RegionName: RegionName;
}
export type FullName = string;
export interface GetAlternateContactRequest {
/**
* Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
/**
* Specifies which alternate contact you want to retrieve.
*/
AlternateContactType: AlternateContactType;
}
export interface GetAlternateContactResponse {
/**
* A structure that contains the details for the specified alternate contact.
*/
AlternateContact?: AlternateContact;
}
export interface GetContactInformationRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
}
export interface GetContactInformationResponse {
/**
* Contains the details of the primary contact information associated with an Amazon Web Services account.
*/
ContactInformation?: ContactInformation;
}
export interface GetPrimaryEmailRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. The management account can't specify its own AccountId.
*/
AccountId: AccountId;
}
export interface GetPrimaryEmailResponse {
/**
* Retrieves the primary email address associated with the specified account.
*/
PrimaryEmail?: PrimaryEmailAddress;
}
export interface GetRegionOptStatusRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
/**
* Specifies the Region-code for a given Region name (for example, af-south-1). This function will return the status of whatever Region you pass into this parameter.
*/
RegionName: RegionName;
}
export interface GetRegionOptStatusResponse {
/**
* The Region code that was passed in.
*/
RegionName?: RegionName;
/**
* One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).
*/
RegionOptStatus?: RegionOptStatus;
}
export interface ListRegionsRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
/**
* The total number of items to return in the commands output. If the total number of items available is more than the value specified, a NextToken is provided in the commands output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.
*/
MaxResults?: ListRegionsRequestMaxResultsInteger;
/**
* A token used to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.
*/
NextToken?: ListRegionsRequestNextTokenString;
/**
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.
*/
RegionOptStatusContains?: RegionOptStatusList;
}
export type ListRegionsRequestMaxResultsInteger = number;
export type ListRegionsRequestNextTokenString = string;
export interface ListRegionsResponse {
/**
* If there is more data to be returned, this will be populated. It should be passed into the next-token request parameter of list-regions.
*/
NextToken?: String;
/**
* This is a list of Regions for a given account, or if the filtered parameter was used, a list of Regions that match the filter criteria set in the filter parameter.
*/
Regions?: RegionOptList;
}
export type Name = string;
export type Otp = string;
export type PhoneNumber = string;
export type PostalCode = string;
export type PrimaryEmailAddress = string;
export type PrimaryEmailUpdateStatus = "PENDING"|"ACCEPTED"|string;
export interface PutAlternateContactRequest {
/**
* Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
/**
* Specifies which alternate contact you want to create or update.
*/
AlternateContactType: AlternateContactType;
/**
* Specifies an email address for the alternate contact.
*/
EmailAddress: EmailAddress;
/**
* Specifies a name for the alternate contact.
*/
Name: Name;
/**
* Specifies a phone number for the alternate contact.
*/
PhoneNumber: PhoneNumber;
/**
* Specifies a title for the alternate contact.
*/
Title: Title;
}
export interface PutContactInformationRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter. To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
*/
AccountId?: AccountId;
/**
* Contains the details of the primary contact information associated with an Amazon Web Services account.
*/
ContactInformation: ContactInformation;
}
export interface Region {
/**
* The Region code of a given Region (for example, us-east-1).
*/
RegionName?: RegionName;
/**
* One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).
*/
RegionOptStatus?: RegionOptStatus;
}
export type RegionName = string;
export type RegionOptList = Region[];
export type RegionOptStatus = "ENABLED"|"ENABLING"|"DISABLING"|"DISABLED"|"ENABLED_BY_DEFAULT"|string;
export type RegionOptStatusList = RegionOptStatus[];
export interface StartPrimaryEmailUpdateRequest {
/**
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. The management account can't specify its own AccountId.
*/
AccountId: AccountId;
/**
* The new primary email address (also known as the root user email address) to use in the specified account.
*/
PrimaryEmail: PrimaryEmailAddress;
}
export interface StartPrimaryEmailUpdateResponse {
/**
* The status of the primary email update request.
*/
Status?: PrimaryEmailUpdateStatus;
}
export type StateOrRegion = string;
export type String = string;
export type Title = string;
export type WebsiteUrl = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2021-02-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Account client.
*/
export import Types = Account;
}
export = Account;
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['account'] = {};
AWS.Account = Service.defineService('account', ['2021-02-01']);
Object.defineProperty(apiLoader.services['account'], '2021-02-01', {
get: function get() {
var model = require('../apis/account-2021-02-01.min.json');
model.paginators = require('../apis/account-2021-02-01.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Account;
+750
View File
@@ -0,0 +1,750 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ACM extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ACM.Types.ClientConfiguration)
config: Config & ACM.Types.ClientConfiguration;
/**
* Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services 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. 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.
*/
addTagsToCertificate(params: ACM.Types.AddTagsToCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services 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. 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.
*/
addTagsToCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list 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 Amazon Web Services services integrated with ACM. You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.
*/
deleteCertificate(params: ACM.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list 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 Amazon Web Services services integrated with ACM. You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.
*/
deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns detailed metadata about the specified ACM certificate. If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.
*/
describeCertificate(params: ACM.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>;
/**
* Returns detailed metadata about the specified ACM certificate. If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.
*/
describeCertificate(callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>;
/**
* Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.
*/
exportCertificate(params: ACM.Types.ExportCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ExportCertificateResponse) => void): Request<ACM.Types.ExportCertificateResponse, AWSError>;
/**
* Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.
*/
exportCertificate(callback?: (err: AWSError, data: ACM.Types.ExportCertificateResponse) => void): Request<ACM.Types.ExportCertificateResponse, AWSError>;
/**
* Returns the account configuration options associated with an Amazon Web Services account.
*/
getAccountConfiguration(callback?: (err: AWSError, data: ACM.Types.GetAccountConfigurationResponse) => void): Request<ACM.Types.GetAccountConfigurationResponse, AWSError>;
/**
* Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.
*/
getCertificate(params: ACM.Types.GetCertificateRequest, callback?: (err: AWSError, data: ACM.Types.GetCertificateResponse) => void): Request<ACM.Types.GetCertificateResponse, AWSError>;
/**
* Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.
*/
getCertificate(callback?: (err: AWSError, data: ACM.Types.GetCertificateResponse) => void): Request<ACM.Types.GetCertificateResponse, AWSError>;
/**
* Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. The private key must be no larger than 5 KB (5,120 bytes). The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA. This operation returns the Amazon Resource Name (ARN) of the imported certificate.
*/
importCertificate(params: ACM.Types.ImportCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ImportCertificateResponse) => void): Request<ACM.Types.ImportCertificateResponse, AWSError>;
/**
* Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide. ACM does not provide managed renewal for certificates that you import. Note the following guidelines when importing third party certificates: You must enter the private key that matches the certificate you are importing. The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase. The private key must be no larger than 5 KB (5,120 bytes). The certificate, private key, and certificate chain must be PEM-encoded. The current time must be between the Not Before and Not After certificate fields. The Issuer field must not be empty. The OCSP authority URL, if present, must not exceed 1000 characters. To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate. When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA. This operation returns the Amazon Resource Name (ARN) of the imported certificate.
*/
importCertificate(callback?: (err: AWSError, data: ACM.Types.ImportCertificateResponse) => void): Request<ACM.Types.ImportCertificateResponse, AWSError>;
/**
* Retrieves a list of certificate ARNs and domain names. By default, the API returns RSA_2048 certificates. To return all certificates in the account, include the keyType filter with the values [RSA_1024, RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1]. In addition to keyType, you can also filter by the CertificateStatuses, keyUsage, and extendedKeyUsage attributes on the certificate. For more information, see Filters.
*/
listCertificates(params: ACM.Types.ListCertificatesRequest, callback?: (err: AWSError, data: ACM.Types.ListCertificatesResponse) => void): Request<ACM.Types.ListCertificatesResponse, AWSError>;
/**
* Retrieves a list of certificate ARNs and domain names. By default, the API returns RSA_2048 certificates. To return all certificates in the account, include the keyType filter with the values [RSA_1024, RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1]. In addition to keyType, you can also filter by the CertificateStatuses, keyUsage, and extendedKeyUsage attributes on the certificate. For more information, see Filters.
*/
listCertificates(callback?: (err: AWSError, data: ACM.Types.ListCertificatesResponse) => void): Request<ACM.Types.ListCertificatesResponse, AWSError>;
/**
* Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (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.
*/
listTagsForCertificate(params: ACM.Types.ListTagsForCertificateRequest, callback?: (err: AWSError, data: ACM.Types.ListTagsForCertificateResponse) => void): Request<ACM.Types.ListTagsForCertificateResponse, AWSError>;
/**
* Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (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.
*/
listTagsForCertificate(callback?: (err: AWSError, data: ACM.Types.ListTagsForCertificateResponse) => void): Request<ACM.Types.ListTagsForCertificateResponse, AWSError>;
/**
* Adds or modifies account-level configurations in ACM. The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.
*/
putAccountConfiguration(params: ACM.Types.PutAccountConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds or modifies account-level configurations in ACM. The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.
*/
putAccountConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
removeTagsFromCertificate(params: ACM.Types.RemoveTagsFromCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
removeTagsFromCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.
*/
renewCertificate(params: ACM.Types.RenewCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.
*/
renewCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner. ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN). After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.
*/
requestCertificate(params: ACM.Types.RequestCertificateRequest, callback?: (err: AWSError, data: ACM.Types.RequestCertificateResponse) => void): Request<ACM.Types.RequestCertificateResponse, AWSError>;
/**
* Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner. ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN). After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.
*/
requestCertificate(callback?: (err: AWSError, data: ACM.Types.RequestCertificateResponse) => void): Request<ACM.Types.RequestCertificateResponse, AWSError>;
/**
* 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. For more information about setting up your contact email addresses, see Configure Email for your Domain.
*/
resendValidationEmail(params: ACM.Types.ResendValidationEmailRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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. For more information about setting up your contact email addresses, see Configure Email for your Domain.
*/
resendValidationEmail(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.
*/
updateCertificateOptions(params: ACM.Types.UpdateCertificateOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.
*/
updateCertificateOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Waits for the certificateValidated state by periodically calling the underlying ACM.describeCertificateoperation every 60 seconds (at most 40 times).
*/
waitFor(state: "certificateValidated", params: ACM.Types.DescribeCertificateRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>;
/**
* Waits for the certificateValidated state by periodically calling the underlying ACM.describeCertificateoperation every 60 seconds (at most 40 times).
*/
waitFor(state: "certificateValidated", callback?: (err: AWSError, data: ACM.Types.DescribeCertificateResponse) => void): Request<ACM.Types.DescribeCertificateResponse, AWSError>;
}
declare namespace ACM {
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).
*/
CertificateArn: Arn;
/**
* The key-value pair that defines the tag. The tag value is optional.
*/
Tags: TagList;
}
export type Arn = string;
export type CertificateBody = string;
export type CertificateBodyBlob = Buffer|Uint8Array|Blob|string;
export type CertificateChain = string;
export type CertificateChainBlob = Buffer|Uint8Array|Blob|string;
export interface CertificateDetail {
/**
* The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
*/
CertificateArn?: Arn;
/**
* The fully qualified domain name 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. This list contains the domain names that are bound to the public key that is 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 initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.
*/
DomainValidationOptions?: DomainValidationList;
/**
* The serial number of the certificate.
*/
Serial?: String;
/**
* The name of the entity that is associated with the public key contained in the certificate.
*/
Subject?: String;
/**
* The name of the certificate authority 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. This value exists only when the certificate type is AMAZON_ISSUED.
*/
IssuedAt?: TStamp;
/**
* The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.
*/
ImportedAt?: TStamp;
/**
* The status of the certificate. A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
*/
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 that was used to generate the public-private key pair.
*/
KeyAlgorithm?: KeyAlgorithm;
/**
* The algorithm that was used to sign the certificate.
*/
SignatureAlgorithm?: String;
/**
* A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.
*/
InUseBy?: InUseList;
/**
* The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.
*/
FailureReason?: FailureReason;
/**
* The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.
*/
Type?: CertificateType;
/**
* Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.
*/
RenewalSummary?: RenewalSummary;
/**
* A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
*/
KeyUsages?: KeyUsageList;
/**
* Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
*/
ExtendedKeyUsages?: ExtendedKeyUsageList;
/**
* The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
*/
CertificateAuthorityArn?: Arn;
/**
* Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
*/
RenewalEligibility?: RenewalEligibility;
/**
* Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.
*/
Options?: CertificateOptions;
}
export interface CertificateOptions {
/**
* You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.
*/
CertificateTransparencyLoggingPreference?: CertificateTransparencyLoggingPreference;
}
export type CertificateStatus = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED"|string;
export type CertificateStatuses = CertificateStatus[];
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).
*/
CertificateArn?: Arn;
/**
* Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
*/
DomainName?: DomainNameString;
/**
* One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is 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. When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
*/
SubjectAlternativeNameSummaries?: DomainList;
/**
* When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
*/
HasAdditionalSubjectAlternativeNames?: NullableBoolean;
/**
* The status of the certificate. A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
*/
Status?: CertificateStatus;
/**
* The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.
*/
Type?: CertificateType;
/**
* The algorithm that was used to generate the public-private key pair.
*/
KeyAlgorithm?: KeyAlgorithm;
/**
* A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
*/
KeyUsages?: KeyUsageNames;
/**
* Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
*/
ExtendedKeyUsages?: ExtendedKeyUsageNames;
/**
* Indicates whether the certificate is currently in use by any Amazon Web Services resources.
*/
InUse?: NullableBoolean;
/**
* Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.
*/
Exported?: NullableBoolean;
/**
* Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
*/
RenewalEligibility?: RenewalEligibility;
/**
* The time before which the certificate is not valid.
*/
NotBefore?: TStamp;
/**
* The time after which the certificate is not valid.
*/
NotAfter?: TStamp;
/**
* The time at which the certificate was requested.
*/
CreatedAt?: TStamp;
/**
* The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
*/
IssuedAt?: TStamp;
/**
* The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.
*/
ImportedAt?: TStamp;
/**
* The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
*/
RevokedAt?: TStamp;
}
export type CertificateSummaryList = CertificateSummary[];
export type CertificateTransparencyLoggingPreference = "ENABLED"|"DISABLED"|string;
export type CertificateType = "IMPORTED"|"AMAZON_ISSUED"|"PRIVATE"|string;
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).
*/
CertificateArn: Arn;
}
export interface DescribeCertificateRequest {
/**
* The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs).
*/
CertificateArn: Arn;
}
export interface DescribeCertificateResponse {
/**
* Metadata about an ACM certificate.
*/
Certificate?: CertificateDetail;
}
export type DomainList = DomainNameString[];
export type DomainNameString = string;
export type DomainStatus = "PENDING_VALIDATION"|"SUCCESS"|"FAILED"|string;
export interface DomainValidation {
/**
* A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.
*/
DomainName: DomainNameString;
/**
* A list of email addresses that ACM used to send domain validation emails.
*/
ValidationEmails?: ValidationEmailList;
/**
* The domain name that ACM used to send domain validation emails.
*/
ValidationDomain?: DomainNameString;
/**
* The validation status of the domain name. This can be one of the following values: PENDING_VALIDATION SUCCESS FAILED
*/
ValidationStatus?: DomainStatus;
/**
* Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership. Note: The CNAME information that you need does not include the name of your domain. If you include&#x2028; your domain name in the DNS database CNAME record, validation fails.&#x2028; For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.
*/
ResourceRecord?: ResourceRecord;
/**
* Specifies the domain validation method.
*/
ValidationMethod?: ValidationMethod;
}
export type DomainValidationList = DomainValidation[];
export interface DomainValidationOption {
/**
* A fully qualified domain name (FQDN) in the certificate request.
*/
DomainName: DomainNameString;
/**
* The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses: admin@example.com administrator@example.com hostmaster@example.com postmaster@example.com webmaster@example.com
*/
ValidationDomain: DomainNameString;
}
export type DomainValidationOptionList = DomainValidationOption[];
export interface ExpiryEventsConfiguration {
/**
* Specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.
*/
DaysBeforeExpiry?: PositiveInteger;
}
export interface ExportCertificateRequest {
/**
* An Amazon Resource Name (ARN) of the issued certificate. This must be of the form: arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
*/
CertificateArn: Arn;
/**
* Passphrase to associate with the encrypted exported private key. When creating your passphrase, you can use any ASCII character except #, $, or %. If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase. openssl rsa -in encrypted_key.pem -out decrypted_key.pem
*/
Passphrase: PassphraseBlob;
}
export interface ExportCertificateResponse {
/**
* The base64 PEM-encoded certificate.
*/
Certificate?: CertificateBody;
/**
* The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.
*/
CertificateChain?: CertificateChain;
/**
* The encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded.
*/
PrivateKey?: PrivateKey;
}
export interface ExtendedKeyUsage {
/**
* The name of an Extended Key Usage value.
*/
Name?: ExtendedKeyUsageName;
/**
* An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280. 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION) 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION) 1.3.6.1.5.5.7.3.3 (CODE_SIGNING) 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION) 1.3.6.1.5.5.7.3.8 (TIME_STAMPING) 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING) 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM) 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL) 1.3.6.1.5.5.7.3.7 (IPSEC_USER)
*/
OID?: String;
}
export type ExtendedKeyUsageFilterList = ExtendedKeyUsageName[];
export type ExtendedKeyUsageList = ExtendedKeyUsage[];
export type ExtendedKeyUsageName = "TLS_WEB_SERVER_AUTHENTICATION"|"TLS_WEB_CLIENT_AUTHENTICATION"|"CODE_SIGNING"|"EMAIL_PROTECTION"|"TIME_STAMPING"|"OCSP_SIGNING"|"IPSEC_END_SYSTEM"|"IPSEC_TUNNEL"|"IPSEC_USER"|"ANY"|"NONE"|"CUSTOM"|string;
export type ExtendedKeyUsageNames = ExtendedKeyUsageName[];
export type FailureReason = "NO_AVAILABLE_CONTACTS"|"ADDITIONAL_VERIFICATION_REQUIRED"|"DOMAIN_NOT_ALLOWED"|"INVALID_PUBLIC_DOMAIN"|"DOMAIN_VALIDATION_DENIED"|"CAA_ERROR"|"PCA_LIMIT_EXCEEDED"|"PCA_INVALID_ARN"|"PCA_INVALID_STATE"|"PCA_REQUEST_FAILED"|"PCA_NAME_CONSTRAINTS_VALIDATION"|"PCA_RESOURCE_NOT_FOUND"|"PCA_INVALID_ARGS"|"PCA_INVALID_DURATION"|"PCA_ACCESS_DENIED"|"SLR_NOT_FOUND"|"OTHER"|string;
export interface Filters {
/**
* Specify one or more ExtendedKeyUsage extension values.
*/
extendedKeyUsage?: ExtendedKeyUsageFilterList;
/**
* Specify one or more KeyUsage extension values.
*/
keyUsage?: KeyUsageFilterList;
/**
* Specify one or more algorithms that can be used to generate key pairs. Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048","RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.
*/
keyTypes?: KeyAlgorithmList;
}
export interface GetAccountConfigurationResponse {
/**
* Expiration events configuration options associated with the Amazon Web Services account.
*/
ExpiryEvents?: ExpiryEventsConfiguration;
}
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).
*/
CertificateArn: Arn;
}
export interface GetCertificateResponse {
/**
* The ACM-issued certificate corresponding to the ARN specified as input.
*/
Certificate?: CertificateBody;
/**
* Certificates forming the requested certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.
*/
CertificateChain?: CertificateChain;
}
export type IdempotencyToken = string;
export interface ImportCertificateRequest {
/**
* The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.
*/
CertificateArn?: Arn;
/**
* The certificate to import.
*/
Certificate: CertificateBodyBlob;
/**
* The private key that matches the public key in the certificate.
*/
PrivateKey: PrivateKeyBlob;
/**
* The PEM encoded certificate chain.
*/
CertificateChain?: CertificateChainBlob;
/**
* One or more resource tags to associate with the imported certificate. Note: You cannot apply tags when reimporting a certificate.
*/
Tags?: TagList;
}
export interface ImportCertificateResponse {
/**
* The Amazon Resource Name (ARN) of the imported certificate.
*/
CertificateArn?: Arn;
}
export type InUseList = String[];
export type KeyAlgorithm = "RSA_1024"|"RSA_2048"|"RSA_3072"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1"|"EC_secp521r1"|string;
export type KeyAlgorithmList = KeyAlgorithm[];
export interface KeyUsage {
/**
* A string value that contains a Key Usage extension name.
*/
Name?: KeyUsageName;
}
export type KeyUsageFilterList = KeyUsageName[];
export type KeyUsageList = KeyUsage[];
export type KeyUsageName = "DIGITAL_SIGNATURE"|"NON_REPUDIATION"|"KEY_ENCIPHERMENT"|"DATA_ENCIPHERMENT"|"KEY_AGREEMENT"|"CERTIFICATE_SIGNING"|"CRL_SIGNING"|"ENCIPHER_ONLY"|"DECIPHER_ONLY"|"ANY"|"CUSTOM"|string;
export type KeyUsageNames = KeyUsageName[];
export interface ListCertificatesRequest {
/**
* Filter the certificate list by status value.
*/
CertificateStatuses?: CertificateStatuses;
/**
* Filter the certificate list. For more information, see the Filters structure.
*/
Includes?: Filters;
/**
* 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;
/**
* Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.
*/
SortBy?: SortBy;
/**
* Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.
*/
SortOrder?: SortOrder;
}
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 have the following form: arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 For more information about ARNs, see Amazon Resource Names (ARNs).
*/
CertificateArn: Arn;
}
export interface ListTagsForCertificateResponse {
/**
* The key-value pairs that define the applied tags.
*/
Tags?: TagList;
}
export type MaxItems = number;
export type NextToken = string;
export type NullableBoolean = boolean;
export type PassphraseBlob = Buffer|Uint8Array|Blob|string;
export type PcaArn = string;
export type PositiveInteger = number;
export type PrivateKey = string;
export type PrivateKeyBlob = Buffer|Uint8Array|Blob|string;
export interface PutAccountConfigurationRequest {
/**
* Specifies expiration events associated with an account.
*/
ExpiryEvents?: ExpiryEventsConfiguration;
/**
* Customer-chosen string used to distinguish between calls to PutAccountConfiguration. Idempotency tokens time out after one hour. If you call PutAccountConfiguration multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request.
*/
IdempotencyToken: IdempotencyToken;
}
export type RecordType = "CNAME"|string;
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).
*/
CertificateArn: Arn;
/**
* The key-value pair that defines the tag to remove.
*/
Tags: TagList;
}
export interface RenewCertificateRequest {
/**
* String that contains the ARN of the ACM certificate to be renewed. 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).
*/
CertificateArn: Arn;
}
export type RenewalEligibility = "ELIGIBLE"|"INELIGIBLE"|string;
export type RenewalStatus = "PENDING_AUTO_RENEWAL"|"PENDING_VALIDATION"|"SUCCESS"|"FAILED"|string;
export interface RenewalSummary {
/**
* The status of ACM's managed renewal of the certificate.
*/
RenewalStatus: RenewalStatus;
/**
* Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.
*/
DomainValidationOptions: DomainValidationList;
/**
* The reason that a renewal request was unsuccessful.
*/
RenewalStatusReason?: FailureReason;
/**
* The time at which the renewal summary was last updated.
*/
UpdatedAt: TStamp;
}
export interface RequestCertificateRequest {
/**
* Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.
*/
DomainName: DomainNameString;
/**
* The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
*/
ValidationMethod?: ValidationMethod;
/**
* 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. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas. The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets. (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
*/
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 domain name that you want ACM to use to send you emails so that you can validate domain ownership.
*/
DomainValidationOptions?: DomainValidationOptionList;
/**
* Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.
*/
Options?: CertificateOptions;
/**
* The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
*/
CertificateAuthorityArn?: PcaArn;
/**
* One or more resource tags to associate with the certificate.
*/
Tags?: TagList;
/**
* Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms. Algorithms supported for an ACM certificate request include: RSA_2048 EC_prime256v1 EC_secp384r1 Other listed algorithms are for imported certificates only. When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key. Default: RSA_2048
*/
KeyAlgorithm?: KeyAlgorithm;
}
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 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: admin@subdomain.example.com administrator@subdomain.example.com hostmaster@subdomain.example.com postmaster@subdomain.example.com webmaster@subdomain.example.com
*/
ValidationDomain: DomainNameString;
}
export interface ResourceRecord {
/**
* The name of the DNS record to create in your domain. This is supplied by ACM.
*/
Name: String;
/**
* The type of DNS record. Currently this can be CNAME.
*/
Type: RecordType;
/**
* The value of the CNAME record to add to your DNS database. This is supplied by ACM.
*/
Value: String;
}
export type RevocationReason = "UNSPECIFIED"|"KEY_COMPROMISE"|"CA_COMPROMISE"|"AFFILIATION_CHANGED"|"SUPERCEDED"|"CESSATION_OF_OPERATION"|"CERTIFICATE_HOLD"|"REMOVE_FROM_CRL"|"PRIVILEGE_WITHDRAWN"|"A_A_COMPROMISE"|string;
export type SortBy = "CREATED_AT"|string;
export type SortOrder = "ASCENDING"|"DESCENDING"|string;
export type String = string;
export type TStamp = Date;
export interface Tag {
/**
* The key of the tag.
*/
Key: TagKey;
/**
* The value of the tag.
*/
Value?: TagValue;
}
export type TagKey = string;
export type TagList = Tag[];
export type TagValue = string;
export interface UpdateCertificateOptionsRequest {
/**
* ARN of the requested certificate to update. This must be of the form: arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012
*/
CertificateArn: Arn;
/**
* Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser.
*/
Options: CertificateOptions;
}
export type ValidationEmailList = String[];
export type ValidationMethod = "EMAIL"|"DNS"|string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2015-12-08"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ACM client.
*/
export import Types = ACM;
}
export = ACM;
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['acm'] = {};
AWS.ACM = Service.defineService('acm', ['2015-12-08']);
Object.defineProperty(apiLoader.services['acm'], '2015-12-08', {
get: function get() {
var model = require('../apis/acm-2015-12-08.min.json');
model.paginators = require('../apis/acm-2015-12-08.paginators.json').pagination;
model.waiters = require('../apis/acm-2015-12-08.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ACM;
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['acmpca'] = {};
AWS.ACMPCA = Service.defineService('acmpca', ['2017-08-22']);
Object.defineProperty(apiLoader.services['acmpca'], '2017-08-22', {
get: function get() {
var model = require('../apis/acm-pca-2017-08-22.min.json');
model.paginators = require('../apis/acm-pca-2017-08-22.paginators.json').pagination;
model.waiters = require('../apis/acm-pca-2017-08-22.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ACMPCA;
+385
View File
@@ -0,0 +1,385 @@
export import ACM = require('./acm');
export import APIGateway = require('./apigateway');
export import ApplicationAutoScaling = require('./applicationautoscaling');
export import AppStream = require('./appstream');
export import AutoScaling = require('./autoscaling');
export import Batch = require('./batch');
export import Budgets = require('./budgets');
export import CloudDirectory = require('./clouddirectory');
export import CloudFormation = require('./cloudformation');
export import CloudFront = require('./cloudfront');
export import CloudHSM = require('./cloudhsm');
export import CloudSearch = require('./cloudsearch');
export import CloudSearchDomain = require('./cloudsearchdomain');
export import CloudTrail = require('./cloudtrail');
export import CloudWatch = require('./cloudwatch');
export import CloudWatchEvents = require('./cloudwatchevents');
export import CloudWatchLogs = require('./cloudwatchlogs');
export import CodeBuild = require('./codebuild');
export import CodeCommit = require('./codecommit');
export import CodeDeploy = require('./codedeploy');
export import CodePipeline = require('./codepipeline');
export import CognitoIdentity = require('./cognitoidentity');
export import CognitoIdentityServiceProvider = require('./cognitoidentityserviceprovider');
export import CognitoSync = require('./cognitosync');
export import ConfigService = require('./configservice');
export import CUR = require('./cur');
export import DataPipeline = require('./datapipeline');
export import DeviceFarm = require('./devicefarm');
export import DirectConnect = require('./directconnect');
export import DirectoryService = require('./directoryservice');
export import Discovery = require('./discovery');
export import DMS = require('./dms');
export import DynamoDB = require('./dynamodb');
export import DynamoDBStreams = require('./dynamodbstreams');
export import EC2 = require('./ec2');
export import ECR = require('./ecr');
export import ECS = require('./ecs');
export import EFS = require('./efs');
export import ElastiCache = require('./elasticache');
export import ElasticBeanstalk = require('./elasticbeanstalk');
export import ELB = require('./elb');
export import ELBv2 = require('./elbv2');
export import EMR = require('./emr');
export import ES = require('./es');
export import ElasticTranscoder = require('./elastictranscoder');
export import Firehose = require('./firehose');
export import GameLift = require('./gamelift');
export import Glacier = require('./glacier');
export import Health = require('./health');
export import IAM = require('./iam');
export import ImportExport = require('./importexport');
export import Inspector = require('./inspector');
export import Iot = require('./iot');
export import IotData = require('./iotdata');
export import Kinesis = require('./kinesis');
export import KinesisAnalytics = require('./kinesisanalytics');
export import KMS = require('./kms');
export import Lambda = require('./lambda');
export import LexRuntime = require('./lexruntime');
export import Lightsail = require('./lightsail');
export import MachineLearning = require('./machinelearning');
export import MarketplaceCommerceAnalytics = require('./marketplacecommerceanalytics');
export import MarketplaceMetering = require('./marketplacemetering');
export import MTurk = require('./mturk');
export import MobileAnalytics = require('./mobileanalytics');
export import OpsWorks = require('./opsworks');
export import OpsWorksCM = require('./opsworkscm');
export import Organizations = require('./organizations');
export import Pinpoint = require('./pinpoint');
export import Polly = require('./polly');
export import RDS = require('./rds');
export import Redshift = require('./redshift');
export import Rekognition = require('./rekognition');
export import ResourceGroupsTaggingAPI = require('./resourcegroupstaggingapi');
export import Route53 = require('./route53');
export import Route53Domains = require('./route53domains');
export import S3 = require('./s3');
export import S3Control = require('./s3control');
export import ServiceCatalog = require('./servicecatalog');
export import SES = require('./ses');
export import Shield = require('./shield');
export import SimpleDB = require('./simpledb');
export import SMS = require('./sms');
export import Snowball = require('./snowball');
export import SNS = require('./sns');
export import SQS = require('./sqs');
export import SSM = require('./ssm');
export import StorageGateway = require('./storagegateway');
export import StepFunctions = require('./stepfunctions');
export import STS = require('./sts');
export import Support = require('./support');
export import SWF = require('./swf');
export import XRay = require('./xray');
export import WAF = require('./waf');
export import WAFRegional = require('./wafregional');
export import WorkDocs = require('./workdocs');
export import WorkSpaces = require('./workspaces');
export import LexModelBuildingService = require('./lexmodelbuildingservice');
export import MarketplaceEntitlementService = require('./marketplaceentitlementservice');
export import Athena = require('./athena');
export import Greengrass = require('./greengrass');
export import DAX = require('./dax');
export import MigrationHub = require('./migrationhub');
export import CloudHSMV2 = require('./cloudhsmv2');
export import Glue = require('./glue');
export import Pricing = require('./pricing');
export import CostExplorer = require('./costexplorer');
export import MediaConvert = require('./mediaconvert');
export import MediaLive = require('./medialive');
export import MediaPackage = require('./mediapackage');
export import MediaStore = require('./mediastore');
export import MediaStoreData = require('./mediastoredata');
export import AppSync = require('./appsync');
export import GuardDuty = require('./guardduty');
export import MQ = require('./mq');
export import Comprehend = require('./comprehend');
export import IoTJobsDataPlane = require('./iotjobsdataplane');
export import KinesisVideoArchivedMedia = require('./kinesisvideoarchivedmedia');
export import KinesisVideoMedia = require('./kinesisvideomedia');
export import KinesisVideo = require('./kinesisvideo');
export import SageMakerRuntime = require('./sagemakerruntime');
export import SageMaker = require('./sagemaker');
export import Translate = require('./translate');
export import ResourceGroups = require('./resourcegroups');
export import Cloud9 = require('./cloud9');
export import ServerlessApplicationRepository = require('./serverlessapplicationrepository');
export import ServiceDiscovery = require('./servicediscovery');
export import WorkMail = require('./workmail');
export import AutoScalingPlans = require('./autoscalingplans');
export import TranscribeService = require('./transcribeservice');
export import Connect = require('./connect');
export import ACMPCA = require('./acmpca');
export import FMS = require('./fms');
export import SecretsManager = require('./secretsmanager');
export import IoTAnalytics = require('./iotanalytics');
export import IoT1ClickDevicesService = require('./iot1clickdevicesservice');
export import IoT1ClickProjects = require('./iot1clickprojects');
export import PI = require('./pi');
export import Neptune = require('./neptune');
export import MediaTailor = require('./mediatailor');
export import EKS = require('./eks');
export import DLM = require('./dlm');
export import Signer = require('./signer');
export import Chime = require('./chime');
export import PinpointEmail = require('./pinpointemail');
export import RAM = require('./ram');
export import Route53Resolver = require('./route53resolver');
export import PinpointSMSVoice = require('./pinpointsmsvoice');
export import QuickSight = require('./quicksight');
export import RDSDataService = require('./rdsdataservice');
export import Amplify = require('./amplify');
export import DataSync = require('./datasync');
export import RoboMaker = require('./robomaker');
export import Transfer = require('./transfer');
export import GlobalAccelerator = require('./globalaccelerator');
export import ComprehendMedical = require('./comprehendmedical');
export import KinesisAnalyticsV2 = require('./kinesisanalyticsv2');
export import MediaConnect = require('./mediaconnect');
export import FSx = require('./fsx');
export import SecurityHub = require('./securityhub');
export import AppMesh = require('./appmesh');
export import LicenseManager = require('./licensemanager');
export import Kafka = require('./kafka');
export import ApiGatewayManagementApi = require('./apigatewaymanagementapi');
export import ApiGatewayV2 = require('./apigatewayv2');
export import DocDB = require('./docdb');
export import Backup = require('./backup');
export import WorkLink = require('./worklink');
export import Textract = require('./textract');
export import ManagedBlockchain = require('./managedblockchain');
export import MediaPackageVod = require('./mediapackagevod');
export import GroundStation = require('./groundstation');
export import IoTThingsGraph = require('./iotthingsgraph');
export import IoTEvents = require('./iotevents');
export import IoTEventsData = require('./ioteventsdata');
export import Personalize = require('./personalize');
export import PersonalizeEvents = require('./personalizeevents');
export import PersonalizeRuntime = require('./personalizeruntime');
export import ApplicationInsights = require('./applicationinsights');
export import ServiceQuotas = require('./servicequotas');
export import EC2InstanceConnect = require('./ec2instanceconnect');
export import EventBridge = require('./eventbridge');
export import LakeFormation = require('./lakeformation');
export import ForecastService = require('./forecastservice');
export import ForecastQueryService = require('./forecastqueryservice');
export import QLDB = require('./qldb');
export import QLDBSession = require('./qldbsession');
export import WorkMailMessageFlow = require('./workmailmessageflow');
export import CodeStarNotifications = require('./codestarnotifications');
export import SavingsPlans = require('./savingsplans');
export import SSO = require('./sso');
export import SSOOIDC = require('./ssooidc');
export import MarketplaceCatalog = require('./marketplacecatalog');
export import DataExchange = require('./dataexchange');
export import SESV2 = require('./sesv2');
export import MigrationHubConfig = require('./migrationhubconfig');
export import ConnectParticipant = require('./connectparticipant');
export import AppConfig = require('./appconfig');
export import IoTSecureTunneling = require('./iotsecuretunneling');
export import WAFV2 = require('./wafv2');
export import ElasticInference = require('./elasticinference');
export import Imagebuilder = require('./imagebuilder');
export import Schemas = require('./schemas');
export import AccessAnalyzer = require('./accessanalyzer');
export import CodeGuruReviewer = require('./codegurureviewer');
export import CodeGuruProfiler = require('./codeguruprofiler');
export import ComputeOptimizer = require('./computeoptimizer');
export import FraudDetector = require('./frauddetector');
export import Kendra = require('./kendra');
export import NetworkManager = require('./networkmanager');
export import Outposts = require('./outposts');
export import AugmentedAIRuntime = require('./augmentedairuntime');
export import EBS = require('./ebs');
export import KinesisVideoSignalingChannels = require('./kinesisvideosignalingchannels');
export import Detective = require('./detective');
export import CodeStarconnections = require('./codestarconnections');
export import Synthetics = require('./synthetics');
export import IoTSiteWise = require('./iotsitewise');
export import Macie2 = require('./macie2');
export import CodeArtifact = require('./codeartifact');
export import IVS = require('./ivs');
export import Braket = require('./braket');
export import IdentityStore = require('./identitystore');
export import Appflow = require('./appflow');
export import RedshiftData = require('./redshiftdata');
export import SSOAdmin = require('./ssoadmin');
export import TimestreamQuery = require('./timestreamquery');
export import TimestreamWrite = require('./timestreamwrite');
export import S3Outposts = require('./s3outposts');
export import DataBrew = require('./databrew');
export import ServiceCatalogAppRegistry = require('./servicecatalogappregistry');
export import NetworkFirewall = require('./networkfirewall');
export import MWAA = require('./mwaa');
export import AmplifyBackend = require('./amplifybackend');
export import AppIntegrations = require('./appintegrations');
export import ConnectContactLens = require('./connectcontactlens');
export import DevOpsGuru = require('./devopsguru');
export import ECRPUBLIC = require('./ecrpublic');
export import LookoutVision = require('./lookoutvision');
export import SageMakerFeatureStoreRuntime = require('./sagemakerfeaturestoreruntime');
export import CustomerProfiles = require('./customerprofiles');
export import AuditManager = require('./auditmanager');
export import EMRcontainers = require('./emrcontainers');
export import HealthLake = require('./healthlake');
export import SagemakerEdge = require('./sagemakeredge');
export import Amp = require('./amp');
export import GreengrassV2 = require('./greengrassv2');
export import IotDeviceAdvisor = require('./iotdeviceadvisor');
export import IoTFleetHub = require('./iotfleethub');
export import IoTWireless = require('./iotwireless');
export import Location = require('./location');
export import WellArchitected = require('./wellarchitected');
export import LexModelsV2 = require('./lexmodelsv2');
export import LexRuntimeV2 = require('./lexruntimev2');
export import Fis = require('./fis');
export import LookoutMetrics = require('./lookoutmetrics');
export import Mgn = require('./mgn');
export import LookoutEquipment = require('./lookoutequipment');
export import Nimble = require('./nimble');
export import Finspace = require('./finspace');
export import Finspacedata = require('./finspacedata');
export import SSMContacts = require('./ssmcontacts');
export import SSMIncidents = require('./ssmincidents');
export import ApplicationCostProfiler = require('./applicationcostprofiler');
export import AppRunner = require('./apprunner');
export import Proton = require('./proton');
export import Route53RecoveryCluster = require('./route53recoverycluster');
export import Route53RecoveryControlConfig = require('./route53recoverycontrolconfig');
export import Route53RecoveryReadiness = require('./route53recoveryreadiness');
export import ChimeSDKIdentity = require('./chimesdkidentity');
export import ChimeSDKMessaging = require('./chimesdkmessaging');
export import SnowDeviceManagement = require('./snowdevicemanagement');
export import MemoryDB = require('./memorydb');
export import OpenSearch = require('./opensearch');
export import KafkaConnect = require('./kafkaconnect');
export import VoiceID = require('./voiceid');
export import Wisdom = require('./wisdom');
export import Account = require('./account');
export import CloudControl = require('./cloudcontrol');
export import Grafana = require('./grafana');
export import Panorama = require('./panorama');
export import ChimeSDKMeetings = require('./chimesdkmeetings');
export import Resiliencehub = require('./resiliencehub');
export import MigrationHubStrategy = require('./migrationhubstrategy');
export import AppConfigData = require('./appconfigdata');
export import Drs = require('./drs');
export import MigrationHubRefactorSpaces = require('./migrationhubrefactorspaces');
export import Evidently = require('./evidently');
export import Inspector2 = require('./inspector2');
export import Rbin = require('./rbin');
export import RUM = require('./rum');
export import BackupGateway = require('./backupgateway');
export import IoTTwinMaker = require('./iottwinmaker');
export import WorkSpacesWeb = require('./workspacesweb');
export import AmplifyUIBuilder = require('./amplifyuibuilder');
export import Keyspaces = require('./keyspaces');
export import Billingconductor = require('./billingconductor');
export import PinpointSMSVoiceV2 = require('./pinpointsmsvoicev2');
export import Ivschat = require('./ivschat');
export import ChimeSDKMediaPipelines = require('./chimesdkmediapipelines');
export import EMRServerless = require('./emrserverless');
export import M2 = require('./m2');
export import ConnectCampaigns = require('./connectcampaigns');
export import RedshiftServerless = require('./redshiftserverless');
export import RolesAnywhere = require('./rolesanywhere');
export import LicenseManagerUserSubscriptions = require('./licensemanagerusersubscriptions');
export import PrivateNetworks = require('./privatenetworks');
export import SupportApp = require('./supportapp');
export import ControlTower = require('./controltower');
export import IoTFleetWise = require('./iotfleetwise');
export import MigrationHubOrchestrator = require('./migrationhuborchestrator');
export import ConnectCases = require('./connectcases');
export import ResourceExplorer2 = require('./resourceexplorer2');
export import Scheduler = require('./scheduler');
export import ChimeSDKVoice = require('./chimesdkvoice');
export import SsmSap = require('./ssmsap');
export import OAM = require('./oam');
export import ARCZonalShift = require('./arczonalshift');
export import Omics = require('./omics');
export import OpenSearchServerless = require('./opensearchserverless');
export import SecurityLake = require('./securitylake');
export import SimSpaceWeaver = require('./simspaceweaver');
export import DocDBElastic = require('./docdbelastic');
export import SageMakerGeospatial = require('./sagemakergeospatial');
export import CodeCatalyst = require('./codecatalyst');
export import Pipes = require('./pipes');
export import SageMakerMetrics = require('./sagemakermetrics');
export import KinesisVideoWebRTCStorage = require('./kinesisvideowebrtcstorage');
export import LicenseManagerLinuxSubscriptions = require('./licensemanagerlinuxsubscriptions');
export import KendraRanking = require('./kendraranking');
export import CleanRooms = require('./cleanrooms');
export import CloudTrailData = require('./cloudtraildata');
export import Tnb = require('./tnb');
export import InternetMonitor = require('./internetmonitor');
export import IVSRealTime = require('./ivsrealtime');
export import VPCLattice = require('./vpclattice');
export import OSIS = require('./osis');
export import MediaPackageV2 = require('./mediapackagev2');
export import PaymentCryptography = require('./paymentcryptography');
export import PaymentCryptographyData = require('./paymentcryptographydata');
export import CodeGuruSecurity = require('./codegurusecurity');
export import VerifiedPermissions = require('./verifiedpermissions');
export import AppFabric = require('./appfabric');
export import MedicalImaging = require('./medicalimaging');
export import EntityResolution = require('./entityresolution');
export import ManagedBlockchainQuery = require('./managedblockchainquery');
export import Neptunedata = require('./neptunedata');
export import PcaConnectorAd = require('./pcaconnectorad');
export import Bedrock = require('./bedrock');
export import BedrockRuntime = require('./bedrockruntime');
export import DataZone = require('./datazone');
export import LaunchWizard = require('./launchwizard');
export import TrustedAdvisor = require('./trustedadvisor');
export import InspectorScan = require('./inspectorscan');
export import BCMDataExports = require('./bcmdataexports');
export import CostOptimizationHub = require('./costoptimizationhub');
export import EKSAuth = require('./eksauth');
export import FreeTier = require('./freetier');
export import Repostspace = require('./repostspace');
export import WorkSpacesThinClient = require('./workspacesthinclient');
export import B2bi = require('./b2bi');
export import BedrockAgent = require('./bedrockagent');
export import BedrockAgentRuntime = require('./bedrockagentruntime');
export import QBusiness = require('./qbusiness');
export import QConnect = require('./qconnect');
export import CleanRoomsML = require('./cleanroomsml');
export import MarketplaceAgreement = require('./marketplaceagreement');
export import MarketplaceDeployment = require('./marketplacedeployment');
export import NetworkMonitor = require('./networkmonitor');
export import SupplyChain = require('./supplychain');
export import Artifact = require('./artifact');
export import Chatbot = require('./chatbot');
export import TimestreamInfluxDB = require('./timestreaminfluxdb');
export import CodeConnections = require('./codeconnections');
export import Deadline = require('./deadline');
export import ControlCatalog = require('./controlcatalog');
export import Route53Profiles = require('./route53profiles');
export import MailManager = require('./mailmanager');
export import TaxSettings = require('./taxsettings');
export import ApplicationSignals = require('./applicationsignals');
export import PcaConnectorScep = require('./pcaconnectorscep');
export import AppTest = require('./apptest');
export import QApps = require('./qapps');
export import SSMQuickSetup = require('./ssmquicksetup');
export import PCS = require('./pcs');
+388
View File
@@ -0,0 +1,388 @@
require('../lib/node_loader');
module.exports = {
ACM: require('./acm'),
APIGateway: require('./apigateway'),
ApplicationAutoScaling: require('./applicationautoscaling'),
AppStream: require('./appstream'),
AutoScaling: require('./autoscaling'),
Batch: require('./batch'),
Budgets: require('./budgets'),
CloudDirectory: require('./clouddirectory'),
CloudFormation: require('./cloudformation'),
CloudFront: require('./cloudfront'),
CloudHSM: require('./cloudhsm'),
CloudSearch: require('./cloudsearch'),
CloudSearchDomain: require('./cloudsearchdomain'),
CloudTrail: require('./cloudtrail'),
CloudWatch: require('./cloudwatch'),
CloudWatchEvents: require('./cloudwatchevents'),
CloudWatchLogs: require('./cloudwatchlogs'),
CodeBuild: require('./codebuild'),
CodeCommit: require('./codecommit'),
CodeDeploy: require('./codedeploy'),
CodePipeline: require('./codepipeline'),
CognitoIdentity: require('./cognitoidentity'),
CognitoIdentityServiceProvider: require('./cognitoidentityserviceprovider'),
CognitoSync: require('./cognitosync'),
ConfigService: require('./configservice'),
CUR: require('./cur'),
DataPipeline: require('./datapipeline'),
DeviceFarm: require('./devicefarm'),
DirectConnect: require('./directconnect'),
DirectoryService: require('./directoryservice'),
Discovery: require('./discovery'),
DMS: require('./dms'),
DynamoDB: require('./dynamodb'),
DynamoDBStreams: require('./dynamodbstreams'),
EC2: require('./ec2'),
ECR: require('./ecr'),
ECS: require('./ecs'),
EFS: require('./efs'),
ElastiCache: require('./elasticache'),
ElasticBeanstalk: require('./elasticbeanstalk'),
ELB: require('./elb'),
ELBv2: require('./elbv2'),
EMR: require('./emr'),
ES: require('./es'),
ElasticTranscoder: require('./elastictranscoder'),
Firehose: require('./firehose'),
GameLift: require('./gamelift'),
Glacier: require('./glacier'),
Health: require('./health'),
IAM: require('./iam'),
ImportExport: require('./importexport'),
Inspector: require('./inspector'),
Iot: require('./iot'),
IotData: require('./iotdata'),
Kinesis: require('./kinesis'),
KinesisAnalytics: require('./kinesisanalytics'),
KMS: require('./kms'),
Lambda: require('./lambda'),
LexRuntime: require('./lexruntime'),
Lightsail: require('./lightsail'),
MachineLearning: require('./machinelearning'),
MarketplaceCommerceAnalytics: require('./marketplacecommerceanalytics'),
MarketplaceMetering: require('./marketplacemetering'),
MTurk: require('./mturk'),
MobileAnalytics: require('./mobileanalytics'),
OpsWorks: require('./opsworks'),
OpsWorksCM: require('./opsworkscm'),
Organizations: require('./organizations'),
Pinpoint: require('./pinpoint'),
Polly: require('./polly'),
RDS: require('./rds'),
Redshift: require('./redshift'),
Rekognition: require('./rekognition'),
ResourceGroupsTaggingAPI: require('./resourcegroupstaggingapi'),
Route53: require('./route53'),
Route53Domains: require('./route53domains'),
S3: require('./s3'),
S3Control: require('./s3control'),
ServiceCatalog: require('./servicecatalog'),
SES: require('./ses'),
Shield: require('./shield'),
SimpleDB: require('./simpledb'),
SMS: require('./sms'),
Snowball: require('./snowball'),
SNS: require('./sns'),
SQS: require('./sqs'),
SSM: require('./ssm'),
StorageGateway: require('./storagegateway'),
StepFunctions: require('./stepfunctions'),
STS: require('./sts'),
Support: require('./support'),
SWF: require('./swf'),
XRay: require('./xray'),
WAF: require('./waf'),
WAFRegional: require('./wafregional'),
WorkDocs: require('./workdocs'),
WorkSpaces: require('./workspaces'),
LexModelBuildingService: require('./lexmodelbuildingservice'),
MarketplaceEntitlementService: require('./marketplaceentitlementservice'),
Athena: require('./athena'),
Greengrass: require('./greengrass'),
DAX: require('./dax'),
MigrationHub: require('./migrationhub'),
CloudHSMV2: require('./cloudhsmv2'),
Glue: require('./glue'),
Pricing: require('./pricing'),
CostExplorer: require('./costexplorer'),
MediaConvert: require('./mediaconvert'),
MediaLive: require('./medialive'),
MediaPackage: require('./mediapackage'),
MediaStore: require('./mediastore'),
MediaStoreData: require('./mediastoredata'),
AppSync: require('./appsync'),
GuardDuty: require('./guardduty'),
MQ: require('./mq'),
Comprehend: require('./comprehend'),
IoTJobsDataPlane: require('./iotjobsdataplane'),
KinesisVideoArchivedMedia: require('./kinesisvideoarchivedmedia'),
KinesisVideoMedia: require('./kinesisvideomedia'),
KinesisVideo: require('./kinesisvideo'),
SageMakerRuntime: require('./sagemakerruntime'),
SageMaker: require('./sagemaker'),
Translate: require('./translate'),
ResourceGroups: require('./resourcegroups'),
Cloud9: require('./cloud9'),
ServerlessApplicationRepository: require('./serverlessapplicationrepository'),
ServiceDiscovery: require('./servicediscovery'),
WorkMail: require('./workmail'),
AutoScalingPlans: require('./autoscalingplans'),
TranscribeService: require('./transcribeservice'),
Connect: require('./connect'),
ACMPCA: require('./acmpca'),
FMS: require('./fms'),
SecretsManager: require('./secretsmanager'),
IoTAnalytics: require('./iotanalytics'),
IoT1ClickDevicesService: require('./iot1clickdevicesservice'),
IoT1ClickProjects: require('./iot1clickprojects'),
PI: require('./pi'),
Neptune: require('./neptune'),
MediaTailor: require('./mediatailor'),
EKS: require('./eks'),
DLM: require('./dlm'),
Signer: require('./signer'),
Chime: require('./chime'),
PinpointEmail: require('./pinpointemail'),
RAM: require('./ram'),
Route53Resolver: require('./route53resolver'),
PinpointSMSVoice: require('./pinpointsmsvoice'),
QuickSight: require('./quicksight'),
RDSDataService: require('./rdsdataservice'),
Amplify: require('./amplify'),
DataSync: require('./datasync'),
RoboMaker: require('./robomaker'),
Transfer: require('./transfer'),
GlobalAccelerator: require('./globalaccelerator'),
ComprehendMedical: require('./comprehendmedical'),
KinesisAnalyticsV2: require('./kinesisanalyticsv2'),
MediaConnect: require('./mediaconnect'),
FSx: require('./fsx'),
SecurityHub: require('./securityhub'),
AppMesh: require('./appmesh'),
LicenseManager: require('./licensemanager'),
Kafka: require('./kafka'),
ApiGatewayManagementApi: require('./apigatewaymanagementapi'),
ApiGatewayV2: require('./apigatewayv2'),
DocDB: require('./docdb'),
Backup: require('./backup'),
WorkLink: require('./worklink'),
Textract: require('./textract'),
ManagedBlockchain: require('./managedblockchain'),
MediaPackageVod: require('./mediapackagevod'),
GroundStation: require('./groundstation'),
IoTThingsGraph: require('./iotthingsgraph'),
IoTEvents: require('./iotevents'),
IoTEventsData: require('./ioteventsdata'),
Personalize: require('./personalize'),
PersonalizeEvents: require('./personalizeevents'),
PersonalizeRuntime: require('./personalizeruntime'),
ApplicationInsights: require('./applicationinsights'),
ServiceQuotas: require('./servicequotas'),
EC2InstanceConnect: require('./ec2instanceconnect'),
EventBridge: require('./eventbridge'),
LakeFormation: require('./lakeformation'),
ForecastService: require('./forecastservice'),
ForecastQueryService: require('./forecastqueryservice'),
QLDB: require('./qldb'),
QLDBSession: require('./qldbsession'),
WorkMailMessageFlow: require('./workmailmessageflow'),
CodeStarNotifications: require('./codestarnotifications'),
SavingsPlans: require('./savingsplans'),
SSO: require('./sso'),
SSOOIDC: require('./ssooidc'),
MarketplaceCatalog: require('./marketplacecatalog'),
DataExchange: require('./dataexchange'),
SESV2: require('./sesv2'),
MigrationHubConfig: require('./migrationhubconfig'),
ConnectParticipant: require('./connectparticipant'),
AppConfig: require('./appconfig'),
IoTSecureTunneling: require('./iotsecuretunneling'),
WAFV2: require('./wafv2'),
ElasticInference: require('./elasticinference'),
Imagebuilder: require('./imagebuilder'),
Schemas: require('./schemas'),
AccessAnalyzer: require('./accessanalyzer'),
CodeGuruReviewer: require('./codegurureviewer'),
CodeGuruProfiler: require('./codeguruprofiler'),
ComputeOptimizer: require('./computeoptimizer'),
FraudDetector: require('./frauddetector'),
Kendra: require('./kendra'),
NetworkManager: require('./networkmanager'),
Outposts: require('./outposts'),
AugmentedAIRuntime: require('./augmentedairuntime'),
EBS: require('./ebs'),
KinesisVideoSignalingChannels: require('./kinesisvideosignalingchannels'),
Detective: require('./detective'),
CodeStarconnections: require('./codestarconnections'),
Synthetics: require('./synthetics'),
IoTSiteWise: require('./iotsitewise'),
Macie2: require('./macie2'),
CodeArtifact: require('./codeartifact'),
IVS: require('./ivs'),
Braket: require('./braket'),
IdentityStore: require('./identitystore'),
Appflow: require('./appflow'),
RedshiftData: require('./redshiftdata'),
SSOAdmin: require('./ssoadmin'),
TimestreamQuery: require('./timestreamquery'),
TimestreamWrite: require('./timestreamwrite'),
S3Outposts: require('./s3outposts'),
DataBrew: require('./databrew'),
ServiceCatalogAppRegistry: require('./servicecatalogappregistry'),
NetworkFirewall: require('./networkfirewall'),
MWAA: require('./mwaa'),
AmplifyBackend: require('./amplifybackend'),
AppIntegrations: require('./appintegrations'),
ConnectContactLens: require('./connectcontactlens'),
DevOpsGuru: require('./devopsguru'),
ECRPUBLIC: require('./ecrpublic'),
LookoutVision: require('./lookoutvision'),
SageMakerFeatureStoreRuntime: require('./sagemakerfeaturestoreruntime'),
CustomerProfiles: require('./customerprofiles'),
AuditManager: require('./auditmanager'),
EMRcontainers: require('./emrcontainers'),
HealthLake: require('./healthlake'),
SagemakerEdge: require('./sagemakeredge'),
Amp: require('./amp'),
GreengrassV2: require('./greengrassv2'),
IotDeviceAdvisor: require('./iotdeviceadvisor'),
IoTFleetHub: require('./iotfleethub'),
IoTWireless: require('./iotwireless'),
Location: require('./location'),
WellArchitected: require('./wellarchitected'),
LexModelsV2: require('./lexmodelsv2'),
LexRuntimeV2: require('./lexruntimev2'),
Fis: require('./fis'),
LookoutMetrics: require('./lookoutmetrics'),
Mgn: require('./mgn'),
LookoutEquipment: require('./lookoutequipment'),
Nimble: require('./nimble'),
Finspace: require('./finspace'),
Finspacedata: require('./finspacedata'),
SSMContacts: require('./ssmcontacts'),
SSMIncidents: require('./ssmincidents'),
ApplicationCostProfiler: require('./applicationcostprofiler'),
AppRunner: require('./apprunner'),
Proton: require('./proton'),
Route53RecoveryCluster: require('./route53recoverycluster'),
Route53RecoveryControlConfig: require('./route53recoverycontrolconfig'),
Route53RecoveryReadiness: require('./route53recoveryreadiness'),
ChimeSDKIdentity: require('./chimesdkidentity'),
ChimeSDKMessaging: require('./chimesdkmessaging'),
SnowDeviceManagement: require('./snowdevicemanagement'),
MemoryDB: require('./memorydb'),
OpenSearch: require('./opensearch'),
KafkaConnect: require('./kafkaconnect'),
VoiceID: require('./voiceid'),
Wisdom: require('./wisdom'),
Account: require('./account'),
CloudControl: require('./cloudcontrol'),
Grafana: require('./grafana'),
Panorama: require('./panorama'),
ChimeSDKMeetings: require('./chimesdkmeetings'),
Resiliencehub: require('./resiliencehub'),
MigrationHubStrategy: require('./migrationhubstrategy'),
AppConfigData: require('./appconfigdata'),
Drs: require('./drs'),
MigrationHubRefactorSpaces: require('./migrationhubrefactorspaces'),
Evidently: require('./evidently'),
Inspector2: require('./inspector2'),
Rbin: require('./rbin'),
RUM: require('./rum'),
BackupGateway: require('./backupgateway'),
IoTTwinMaker: require('./iottwinmaker'),
WorkSpacesWeb: require('./workspacesweb'),
AmplifyUIBuilder: require('./amplifyuibuilder'),
Keyspaces: require('./keyspaces'),
Billingconductor: require('./billingconductor'),
PinpointSMSVoiceV2: require('./pinpointsmsvoicev2'),
Ivschat: require('./ivschat'),
ChimeSDKMediaPipelines: require('./chimesdkmediapipelines'),
EMRServerless: require('./emrserverless'),
M2: require('./m2'),
ConnectCampaigns: require('./connectcampaigns'),
RedshiftServerless: require('./redshiftserverless'),
RolesAnywhere: require('./rolesanywhere'),
LicenseManagerUserSubscriptions: require('./licensemanagerusersubscriptions'),
PrivateNetworks: require('./privatenetworks'),
SupportApp: require('./supportapp'),
ControlTower: require('./controltower'),
IoTFleetWise: require('./iotfleetwise'),
MigrationHubOrchestrator: require('./migrationhuborchestrator'),
ConnectCases: require('./connectcases'),
ResourceExplorer2: require('./resourceexplorer2'),
Scheduler: require('./scheduler'),
ChimeSDKVoice: require('./chimesdkvoice'),
SsmSap: require('./ssmsap'),
OAM: require('./oam'),
ARCZonalShift: require('./arczonalshift'),
Omics: require('./omics'),
OpenSearchServerless: require('./opensearchserverless'),
SecurityLake: require('./securitylake'),
SimSpaceWeaver: require('./simspaceweaver'),
DocDBElastic: require('./docdbelastic'),
SageMakerGeospatial: require('./sagemakergeospatial'),
CodeCatalyst: require('./codecatalyst'),
Pipes: require('./pipes'),
SageMakerMetrics: require('./sagemakermetrics'),
KinesisVideoWebRTCStorage: require('./kinesisvideowebrtcstorage'),
LicenseManagerLinuxSubscriptions: require('./licensemanagerlinuxsubscriptions'),
KendraRanking: require('./kendraranking'),
CleanRooms: require('./cleanrooms'),
CloudTrailData: require('./cloudtraildata'),
Tnb: require('./tnb'),
InternetMonitor: require('./internetmonitor'),
IVSRealTime: require('./ivsrealtime'),
VPCLattice: require('./vpclattice'),
OSIS: require('./osis'),
MediaPackageV2: require('./mediapackagev2'),
PaymentCryptography: require('./paymentcryptography'),
PaymentCryptographyData: require('./paymentcryptographydata'),
CodeGuruSecurity: require('./codegurusecurity'),
VerifiedPermissions: require('./verifiedpermissions'),
AppFabric: require('./appfabric'),
MedicalImaging: require('./medicalimaging'),
EntityResolution: require('./entityresolution'),
ManagedBlockchainQuery: require('./managedblockchainquery'),
Neptunedata: require('./neptunedata'),
PcaConnectorAd: require('./pcaconnectorad'),
Bedrock: require('./bedrock'),
BedrockRuntime: require('./bedrockruntime'),
DataZone: require('./datazone'),
LaunchWizard: require('./launchwizard'),
TrustedAdvisor: require('./trustedadvisor'),
InspectorScan: require('./inspectorscan'),
BCMDataExports: require('./bcmdataexports'),
CostOptimizationHub: require('./costoptimizationhub'),
EKSAuth: require('./eksauth'),
FreeTier: require('./freetier'),
Repostspace: require('./repostspace'),
WorkSpacesThinClient: require('./workspacesthinclient'),
B2bi: require('./b2bi'),
BedrockAgent: require('./bedrockagent'),
BedrockAgentRuntime: require('./bedrockagentruntime'),
QBusiness: require('./qbusiness'),
QConnect: require('./qconnect'),
CleanRoomsML: require('./cleanroomsml'),
MarketplaceAgreement: require('./marketplaceagreement'),
MarketplaceDeployment: require('./marketplacedeployment'),
NetworkMonitor: require('./networkmonitor'),
SupplyChain: require('./supplychain'),
Artifact: require('./artifact'),
Chatbot: require('./chatbot'),
TimestreamInfluxDB: require('./timestreaminfluxdb'),
CodeConnections: require('./codeconnections'),
Deadline: require('./deadline'),
ControlCatalog: require('./controlcatalog'),
Route53Profiles: require('./route53profiles'),
MailManager: require('./mailmanager'),
TaxSettings: require('./taxsettings'),
ApplicationSignals: require('./applicationsignals'),
PcaConnectorScep: require('./pcaconnectorscep'),
AppTest: require('./apptest'),
QApps: require('./qapps'),
SSMQuickSetup: require('./ssmquicksetup'),
PCS: require('./pcs')
};
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['amp'] = {};
AWS.Amp = Service.defineService('amp', ['2020-08-01']);
Object.defineProperty(apiLoader.services['amp'], '2020-08-01', {
get: function get() {
var model = require('../apis/amp-2020-08-01.min.json');
model.paginators = require('../apis/amp-2020-08-01.paginators.json').pagination;
model.waiters = require('../apis/amp-2020-08-01.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Amp;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['amplify'] = {};
AWS.Amplify = Service.defineService('amplify', ['2017-07-25']);
Object.defineProperty(apiLoader.services['amplify'], '2017-07-25', {
get: function get() {
var model = require('../apis/amplify-2017-07-25.min.json');
model.paginators = require('../apis/amplify-2017-07-25.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Amplify;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['amplifybackend'] = {};
AWS.AmplifyBackend = Service.defineService('amplifybackend', ['2020-08-11']);
Object.defineProperty(apiLoader.services['amplifybackend'], '2020-08-11', {
get: function get() {
var model = require('../apis/amplifybackend-2020-08-11.min.json');
model.paginators = require('../apis/amplifybackend-2020-08-11.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AmplifyBackend;
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['amplifyuibuilder'] = {};
AWS.AmplifyUIBuilder = Service.defineService('amplifyuibuilder', ['2021-08-11']);
Object.defineProperty(apiLoader.services['amplifyuibuilder'], '2021-08-11', {
get: function get() {
var model = require('../apis/amplifyuibuilder-2021-08-11.min.json');
model.paginators = require('../apis/amplifyuibuilder-2021-08-11.paginators.json').pagination;
model.waiters = require('../apis/amplifyuibuilder-2021-08-11.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AmplifyUIBuilder;
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['apigateway'] = {};
AWS.APIGateway = Service.defineService('apigateway', ['2015-07-09']);
require('../lib/services/apigateway');
Object.defineProperty(apiLoader.services['apigateway'], '2015-07-09', {
get: function get() {
var model = require('../apis/apigateway-2015-07-09.min.json');
model.paginators = require('../apis/apigateway-2015-07-09.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.APIGateway;
@@ -0,0 +1,96 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ApiGatewayManagementApi extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ApiGatewayManagementApi.Types.ClientConfiguration)
config: Config & ApiGatewayManagementApi.Types.ClientConfiguration;
/**
* Delete the connection with the provided id.
*/
deleteConnection(params: ApiGatewayManagementApi.Types.DeleteConnectionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete the connection with the provided id.
*/
deleteConnection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Get information about the connection with the provided id.
*/
getConnection(params: ApiGatewayManagementApi.Types.GetConnectionRequest, callback?: (err: AWSError, data: ApiGatewayManagementApi.Types.GetConnectionResponse) => void): Request<ApiGatewayManagementApi.Types.GetConnectionResponse, AWSError>;
/**
* Get information about the connection with the provided id.
*/
getConnection(callback?: (err: AWSError, data: ApiGatewayManagementApi.Types.GetConnectionResponse) => void): Request<ApiGatewayManagementApi.Types.GetConnectionResponse, AWSError>;
/**
* Sends the provided data to the specified connection.
*/
postToConnection(params: ApiGatewayManagementApi.Types.PostToConnectionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sends the provided data to the specified connection.
*/
postToConnection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace ApiGatewayManagementApi {
export type Data = Buffer|Uint8Array|Blob|string;
export interface DeleteConnectionRequest {
ConnectionId: __string;
}
export interface GetConnectionRequest {
ConnectionId: __string;
}
export interface GetConnectionResponse {
/**
* The time in ISO 8601 format for when the connection was established.
*/
ConnectedAt?: __timestampIso8601;
Identity?: Identity;
/**
* The time in ISO 8601 format for when the connection was last active.
*/
LastActiveAt?: __timestampIso8601;
}
export interface Identity {
/**
* The source IP address of the TCP connection making the request to API Gateway.
*/
SourceIp: __string;
/**
* The User Agent of the API caller.
*/
UserAgent: __string;
}
export interface PostToConnectionRequest {
/**
* The data to be sent to the client specified by its connection id.
*/
Data: Data;
/**
* The identifier of the connection that a specific client is using.
*/
ConnectionId: __string;
}
export type __string = string;
export type __timestampIso8601 = Date;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-11-29"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ApiGatewayManagementApi client.
*/
export import Types = ApiGatewayManagementApi;
}
export = ApiGatewayManagementApi;
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['apigatewaymanagementapi'] = {};
AWS.ApiGatewayManagementApi = Service.defineService('apigatewaymanagementapi', ['2018-11-29']);
Object.defineProperty(apiLoader.services['apigatewaymanagementapi'], '2018-11-29', {
get: function get() {
var model = require('../apis/apigatewaymanagementapi-2018-11-29.min.json');
model.paginators = require('../apis/apigatewaymanagementapi-2018-11-29.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ApiGatewayManagementApi;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['apigatewayv2'] = {};
AWS.ApiGatewayV2 = Service.defineService('apigatewayv2', ['2018-11-29']);
Object.defineProperty(apiLoader.services['apigatewayv2'], '2018-11-29', {
get: function get() {
var model = require('../apis/apigatewayv2-2018-11-29.min.json');
model.paginators = require('../apis/apigatewayv2-2018-11-29.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ApiGatewayV2;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['appconfig'] = {};
AWS.AppConfig = Service.defineService('appconfig', ['2019-10-09']);
Object.defineProperty(apiLoader.services['appconfig'], '2019-10-09', {
get: function get() {
var model = require('../apis/appconfig-2019-10-09.min.json');
model.paginators = require('../apis/appconfig-2019-10-09.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppConfig;
+106
View File
@@ -0,0 +1,106 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class AppConfigData extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AppConfigData.Types.ClientConfiguration)
config: Config & AppConfigData.Types.ClientConfiguration;
/**
* Retrieves the latest deployed configuration. This API may return empty configuration data if the client already has the latest version. For more information about this API action and to view example CLI commands that show how to use it with the StartConfigurationSession API action, see Retrieving the configuration in the AppConfig User Guide. Note the following important information. Each configuration token is only valid for one call to GetLatestConfiguration. The GetLatestConfiguration response includes a NextPollConfigurationToken that should always replace the token used for the just-completed call in preparation for the next one. GetLatestConfiguration is a priced call. For more information, see Pricing.
*/
getLatestConfiguration(params: AppConfigData.Types.GetLatestConfigurationRequest, callback?: (err: AWSError, data: AppConfigData.Types.GetLatestConfigurationResponse) => void): Request<AppConfigData.Types.GetLatestConfigurationResponse, AWSError>;
/**
* Retrieves the latest deployed configuration. This API may return empty configuration data if the client already has the latest version. For more information about this API action and to view example CLI commands that show how to use it with the StartConfigurationSession API action, see Retrieving the configuration in the AppConfig User Guide. Note the following important information. Each configuration token is only valid for one call to GetLatestConfiguration. The GetLatestConfiguration response includes a NextPollConfigurationToken that should always replace the token used for the just-completed call in preparation for the next one. GetLatestConfiguration is a priced call. For more information, see Pricing.
*/
getLatestConfiguration(callback?: (err: AWSError, data: AppConfigData.Types.GetLatestConfigurationResponse) => void): Request<AppConfigData.Types.GetLatestConfigurationResponse, AWSError>;
/**
* Starts a configuration session used to retrieve a deployed configuration. For more information about this API action and to view example CLI commands that show how to use it with the GetLatestConfiguration API action, see Retrieving the configuration in the AppConfig User Guide.
*/
startConfigurationSession(params: AppConfigData.Types.StartConfigurationSessionRequest, callback?: (err: AWSError, data: AppConfigData.Types.StartConfigurationSessionResponse) => void): Request<AppConfigData.Types.StartConfigurationSessionResponse, AWSError>;
/**
* Starts a configuration session used to retrieve a deployed configuration. For more information about this API action and to view example CLI commands that show how to use it with the GetLatestConfiguration API action, see Retrieving the configuration in the AppConfig User Guide.
*/
startConfigurationSession(callback?: (err: AWSError, data: AppConfigData.Types.StartConfigurationSessionResponse) => void): Request<AppConfigData.Types.StartConfigurationSessionResponse, AWSError>;
}
declare namespace AppConfigData {
export interface GetLatestConfigurationRequest {
/**
* Token describing the current state of the configuration session. To obtain a token, first call the StartConfigurationSession API. Note that every call to GetLatestConfiguration will return a new ConfigurationToken (NextPollConfigurationToken in the response) and must be provided to subsequent GetLatestConfiguration API calls. This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException.
*/
ConfigurationToken: Token;
}
export interface GetLatestConfigurationResponse {
/**
* The latest token describing the current state of the configuration session. This must be provided to the next call to GetLatestConfiguration. This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException.
*/
NextPollConfigurationToken?: Token;
/**
* The amount of time the client should wait before polling for configuration updates again. Use RequiredMinimumPollIntervalInSeconds to set the desired poll interval.
*/
NextPollIntervalInSeconds?: Integer;
/**
* A standard MIME type describing the format of the configuration content.
*/
ContentType?: String;
/**
* The data of the configuration. This may be empty if the client already has the latest version of configuration.
*/
Configuration?: SensitiveBlob;
/**
* The user-defined label for the AppConfig hosted configuration version. This attribute doesn't apply if the configuration is not from an AppConfig hosted configuration version. If the client already has the latest version of the configuration data, this value is empty.
*/
VersionLabel?: String;
}
export type Identifier = string;
export type Integer = number;
export type OptionalPollSeconds = number;
export type SensitiveBlob = Buffer|Uint8Array|Blob|string;
export interface StartConfigurationSessionRequest {
/**
* The application ID or the application name.
*/
ApplicationIdentifier: Identifier;
/**
* The environment ID or the environment name.
*/
EnvironmentIdentifier: Identifier;
/**
* The configuration profile ID or the configuration profile name.
*/
ConfigurationProfileIdentifier: Identifier;
/**
* Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then the client that established the session can't call GetLatestConfiguration more frequently than every 60 seconds.
*/
RequiredMinimumPollIntervalInSeconds?: OptionalPollSeconds;
}
export interface StartConfigurationSessionResponse {
/**
* Token encapsulating state about the configuration session. Provide this token to the GetLatestConfiguration API to retrieve configuration data. This token should only be used once in your first call to GetLatestConfiguration. You must use the new token in the GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration. The InitialConfigurationToken and NextPollConfigurationToken should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException.
*/
InitialConfigurationToken?: Token;
}
export type String = string;
export type Token = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2021-11-11"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the AppConfigData client.
*/
export import Types = AppConfigData;
}
export = AppConfigData;
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['appconfigdata'] = {};
AWS.AppConfigData = Service.defineService('appconfigdata', ['2021-11-11']);
Object.defineProperty(apiLoader.services['appconfigdata'], '2021-11-11', {
get: function get() {
var model = require('../apis/appconfigdata-2021-11-11.min.json');
model.paginators = require('../apis/appconfigdata-2021-11-11.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppConfigData;
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['appfabric'] = {};
AWS.AppFabric = Service.defineService('appfabric', ['2023-05-19']);
Object.defineProperty(apiLoader.services['appfabric'], '2023-05-19', {
get: function get() {
var model = require('../apis/appfabric-2023-05-19.min.json');
model.paginators = require('../apis/appfabric-2023-05-19.paginators.json').pagination;
model.waiters = require('../apis/appfabric-2023-05-19.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppFabric;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['appflow'] = {};
AWS.Appflow = Service.defineService('appflow', ['2020-08-23']);
Object.defineProperty(apiLoader.services['appflow'], '2020-08-23', {
get: function get() {
var model = require('../apis/appflow-2020-08-23.min.json');
model.paginators = require('../apis/appflow-2020-08-23.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Appflow;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['appintegrations'] = {};
AWS.AppIntegrations = Service.defineService('appintegrations', ['2020-07-29']);
Object.defineProperty(apiLoader.services['appintegrations'], '2020-07-29', {
get: function get() {
var model = require('../apis/appintegrations-2020-07-29.min.json');
model.paginators = require('../apis/appintegrations-2020-07-29.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppIntegrations;
@@ -0,0 +1,937 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ApplicationAutoScaling extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ApplicationAutoScaling.Types.ClientConfiguration)
config: Config & ApplicationAutoScaling.Types.ClientConfiguration;
/**
* Deletes the specified scaling policy for an Application Auto Scaling scalable target. Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action. For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide.
*/
deleteScalingPolicy(params: ApplicationAutoScaling.Types.DeleteScalingPolicyRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.DeleteScalingPolicyResponse, AWSError>;
/**
* Deletes the specified scaling policy for an Application Auto Scaling scalable target. Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action. For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide.
*/
deleteScalingPolicy(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.DeleteScalingPolicyResponse, AWSError>;
/**
* Deletes the specified scheduled action for an Application Auto Scaling scalable target. For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.
*/
deleteScheduledAction(params: ApplicationAutoScaling.Types.DeleteScheduledActionRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScheduledActionResponse) => void): Request<ApplicationAutoScaling.Types.DeleteScheduledActionResponse, AWSError>;
/**
* Deletes the specified scheduled action for an Application Auto Scaling scalable target. For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.
*/
deleteScheduledAction(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScheduledActionResponse) => void): Request<ApplicationAutoScaling.Types.DeleteScheduledActionResponse, AWSError>;
/**
* Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets. Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
*/
deregisterScalableTarget(params: ApplicationAutoScaling.Types.DeregisterScalableTargetRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeregisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.DeregisterScalableTargetResponse, AWSError>;
/**
* Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets. Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
*/
deregisterScalableTarget(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeregisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.DeregisterScalableTargetResponse, AWSError>;
/**
* Gets information about the scalable targets in the specified namespace. You can filter the results using ResourceIds and ScalableDimension.
*/
describeScalableTargets(params: ApplicationAutoScaling.Types.DescribeScalableTargetsRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalableTargetsResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalableTargetsResponse, AWSError>;
/**
* Gets information about the scalable targets in the specified namespace. You can filter the results using ResourceIds and ScalableDimension.
*/
describeScalableTargets(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalableTargetsResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalableTargetsResponse, AWSError>;
/**
* Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks. You can filter the results using ResourceId and ScalableDimension. For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.
*/
describeScalingActivities(params: ApplicationAutoScaling.Types.DescribeScalingActivitiesRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse, AWSError>;
/**
* Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks. You can filter the results using ResourceId and ScalableDimension. For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.
*/
describeScalingActivities(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse, AWSError>;
/**
* Describes the Application Auto Scaling scaling policies for the specified service namespace. You can filter the results using ResourceId, ScalableDimension, and PolicyNames. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
*/
describeScalingPolicies(params: ApplicationAutoScaling.Types.DescribeScalingPoliciesRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse, AWSError>;
/**
* Describes the Application Auto Scaling scaling policies for the specified service namespace. You can filter the results using ResourceId, ScalableDimension, and PolicyNames. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
*/
describeScalingPolicies(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse, AWSError>;
/**
* Describes the Application Auto Scaling scheduled actions for the specified service namespace. You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters. For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
*/
describeScheduledActions(params: ApplicationAutoScaling.Types.DescribeScheduledActionsRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScheduledActionsResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScheduledActionsResponse, AWSError>;
/**
* Describes the Application Auto Scaling scheduled actions for the specified service namespace. You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters. For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
*/
describeScheduledActions(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScheduledActionsResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScheduledActionsResponse, AWSError>;
/**
* Returns all the tags on the specified Application Auto Scaling scalable target. For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.
*/
listTagsForResource(params: ApplicationAutoScaling.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.ListTagsForResourceResponse) => void): Request<ApplicationAutoScaling.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns all the tags on the specified Application Auto Scaling scalable target. For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.
*/
listTagsForResource(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.ListTagsForResourceResponse) => void): Request<ApplicationAutoScaling.Types.ListTagsForResourceResponse, AWSError>;
/**
* Creates or updates a scaling policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target. Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.
*/
putScalingPolicy(params: ApplicationAutoScaling.Types.PutScalingPolicyRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.PutScalingPolicyResponse, AWSError>;
/**
* Creates or updates a scaling policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target. Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.
*/
putScalingPolicy(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.PutScalingPolicyResponse, AWSError>;
/**
* Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target. When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops. To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted. For more information, see Scheduled scaling in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
*/
putScheduledAction(params: ApplicationAutoScaling.Types.PutScheduledActionRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScheduledActionResponse) => void): Request<ApplicationAutoScaling.Types.PutScheduledActionResponse, AWSError>;
/**
* Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target. When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops. To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted. For more information, see Scheduled scaling in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
*/
putScheduledAction(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScheduledActionResponse) => void): Request<ApplicationAutoScaling.Types.PutScheduledActionResponse, AWSError>;
/**
* Registers or updates a scalable target, which is the resource that you want to scale. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service. When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range. If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and maximum range. After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget. To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request. If you call the RegisterScalableTarget API operation to create a scalable target, there might be a brief delay until the operation achieves eventual consistency. You might become aware of this brief delay if you get unexpected errors when performing sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include automatic backoff and retry logic. If you call the RegisterScalableTarget API operation to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it within these bounds, even if you don't include the MinCapacity or MaxCapacity request parameters.
*/
registerScalableTarget(params: ApplicationAutoScaling.Types.RegisterScalableTargetRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.RegisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.RegisterScalableTargetResponse, AWSError>;
/**
* Registers or updates a scalable target, which is the resource that you want to scale. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service. When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range. If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and maximum range. After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget. To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request. If you call the RegisterScalableTarget API operation to create a scalable target, there might be a brief delay until the operation achieves eventual consistency. You might become aware of this brief delay if you get unexpected errors when performing sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include automatic backoff and retry logic. If you call the RegisterScalableTarget API operation to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it within these bounds, even if you don't include the MinCapacity or MaxCapacity request parameters.
*/
registerScalableTarget(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.RegisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.RegisterScalableTargetResponse, AWSError>;
/**
* Adds or edits tags on an Application Auto Scaling scalable target. Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action. You can also add tags to an Application Auto Scaling scalable target while creating it (RegisterScalableTarget). For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference. Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
*/
tagResource(params: ApplicationAutoScaling.Types.TagResourceRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.TagResourceResponse) => void): Request<ApplicationAutoScaling.Types.TagResourceResponse, AWSError>;
/**
* Adds or edits tags on an Application Auto Scaling scalable target. Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action. You can also add tags to an Application Auto Scaling scalable target while creating it (RegisterScalableTarget). For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference. Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
*/
tagResource(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.TagResourceResponse) => void): Request<ApplicationAutoScaling.Types.TagResourceResponse, AWSError>;
/**
* Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.
*/
untagResource(params: ApplicationAutoScaling.Types.UntagResourceRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.UntagResourceResponse) => void): Request<ApplicationAutoScaling.Types.UntagResourceResponse, AWSError>;
/**
* Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.
*/
untagResource(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.UntagResourceResponse) => void): Request<ApplicationAutoScaling.Types.UntagResourceResponse, AWSError>;
}
declare namespace ApplicationAutoScaling {
export type AdjustmentType = "ChangeInCapacity"|"PercentChangeInCapacity"|"ExactCapacity"|string;
export interface Alarm {
/**
* The name of the alarm.
*/
AlarmName: ResourceId;
/**
* The Amazon Resource Name (ARN) of the alarm.
*/
AlarmARN: ResourceId;
}
export type Alarms = Alarm[];
export type AmazonResourceName = string;
export type Cooldown = number;
export interface CustomizedMetricSpecification {
/**
* The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
*/
MetricName?: MetricName;
/**
* The namespace of the metric.
*/
Namespace?: MetricNamespace;
/**
* The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
*/
Dimensions?: MetricDimensions;
/**
* The statistic of the metric.
*/
Statistic?: MetricStatistic;
/**
* The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
*/
Unit?: MetricUnit;
/**
* The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
*/
Metrics?: TargetTrackingMetricDataQueries;
}
export interface DeleteScalingPolicyRequest {
/**
* The name of the scaling policy.
*/
PolicyName: ResourceIdMaxLen1600;
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
}
export interface DeleteScalingPolicyResponse {
}
export interface DeleteScheduledActionRequest {
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The name of the scheduled action.
*/
ScheduledActionName: ResourceIdMaxLen1600;
/**
* The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
}
export interface DeleteScheduledActionResponse {
}
export interface DeregisterScalableTargetRequest {
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
}
export interface DeregisterScalableTargetResponse {
}
export interface DescribeScalableTargetsRequest {
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceIds?: ResourceIdsMaxLen1600;
/**
* The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension?: ScalableDimension;
/**
* The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of results.
*/
NextToken?: XmlString;
}
export interface DescribeScalableTargetsResponse {
/**
* The scalable targets that match the request parameters.
*/
ScalableTargets?: ScalableTargets;
/**
* The token required to get the next set of results. This value is null if there are no more results to return.
*/
NextToken?: XmlString;
}
export interface DescribeScalingActivitiesRequest {
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId?: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension?: ScalableDimension;
/**
* The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of results.
*/
NextToken?: XmlString;
/**
* Specifies whether to include activities that aren't scaled (not scaled activities) in the response. Not scaled activities are activities that aren't completed or started for various reasons, such as preventing infinite scaling loops. For help interpreting the not scaled reason details in the response, see Scaling activities for Application Auto Scaling.
*/
IncludeNotScaledActivities?: IncludeNotScaledActivities;
}
export interface DescribeScalingActivitiesResponse {
/**
* A list of scaling activity objects.
*/
ScalingActivities?: ScalingActivities;
/**
* The token required to get the next set of results. This value is null if there are no more results to return.
*/
NextToken?: XmlString;
}
export interface DescribeScalingPoliciesRequest {
/**
* The names of the scaling policies to describe.
*/
PolicyNames?: ResourceIdsMaxLen1600;
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId?: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension?: ScalableDimension;
/**
* The maximum number of scalable targets. This value can be between 1 and 10. The default value is 10. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 10 results and a NextToken value, if applicable.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of results.
*/
NextToken?: XmlString;
}
export interface DescribeScalingPoliciesResponse {
/**
* Information about the scaling policies.
*/
ScalingPolicies?: ScalingPolicies;
/**
* The token required to get the next set of results. This value is null if there are no more results to return.
*/
NextToken?: XmlString;
}
export interface DescribeScheduledActionsRequest {
/**
* The names of the scheduled actions to describe.
*/
ScheduledActionNames?: ResourceIdsMaxLen1600;
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId?: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension?: ScalableDimension;
/**
* The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of results.
*/
NextToken?: XmlString;
}
export interface DescribeScheduledActionsResponse {
/**
* Information about the scheduled actions.
*/
ScheduledActions?: ScheduledActions;
/**
* The token required to get the next set of results. This value is null if there are no more results to return.
*/
NextToken?: XmlString;
}
export type DisableScaleIn = boolean;
export type Expression = string;
export type Id = string;
export type IncludeNotScaledActivities = boolean;
export interface ListTagsForResourceRequest {
/**
* Specify the ARN of the scalable target. For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 To get the ARN for a scalable target, use DescribeScalableTargets.
*/
ResourceARN: AmazonResourceName;
}
export interface ListTagsForResourceResponse {
/**
* A list of tags. Each tag consists of a tag key and a tag value.
*/
Tags?: TagMap;
}
export type MaxResults = number;
export type MetricAggregationType = "Average"|"Minimum"|"Maximum"|string;
export interface MetricDimension {
/**
* The name of the dimension.
*/
Name: MetricDimensionName;
/**
* The value of the dimension.
*/
Value: MetricDimensionValue;
}
export type MetricDimensionName = string;
export type MetricDimensionValue = string;
export type MetricDimensions = MetricDimension[];
export type MetricName = string;
export type MetricNamespace = string;
export type MetricScale = number;
export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string;
export type MetricType = "DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|"SageMakerVariantInvocationsPerInstance"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"AppStreamAverageCapacityUtilization"|"ComprehendInferenceUtilization"|"LambdaProvisionedConcurrencyUtilization"|"CassandraReadCapacityUtilization"|"CassandraWriteCapacityUtilization"|"KafkaBrokerStorageUtilization"|"ElastiCachePrimaryEngineCPUUtilization"|"ElastiCacheReplicaEngineCPUUtilization"|"ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage"|"NeptuneReaderAverageCPUUtilization"|"SageMakerVariantProvisionedConcurrencyUtilization"|"ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage"|"SageMakerInferenceComponentInvocationsPerCopy"|"WorkSpacesAverageUserSessionsCapacityUtilization"|"SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution"|"SageMakerVariantConcurrentRequestsPerModelHighResolution"|string;
export type MetricUnit = string;
export type MinAdjustmentMagnitude = number;
export interface NotScaledReason {
/**
* A code that represents the reason for not scaling. Valid values: AutoScalingAnticipatedFlapping TargetServicePutResourceAsUnscalable AlreadyAtMaxCapacity AlreadyAtMinCapacity AlreadyAtDesiredCapacity
*/
Code: XmlString;
/**
* The maximum capacity.
*/
MaxCapacity?: ResourceCapacity;
/**
* The minimum capacity.
*/
MinCapacity?: ResourceCapacity;
/**
* The current capacity.
*/
CurrentCapacity?: ResourceCapacity;
}
export type NotScaledReasons = NotScaledReason[];
export type PolicyName = string;
export type PolicyType = "StepScaling"|"TargetTrackingScaling"|string;
export interface PredefinedMetricSpecification {
/**
* The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
*/
PredefinedMetricType: MetricType;
/**
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where: app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN. To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
*/
ResourceLabel?: ResourceLabel;
}
export interface PutScalingPolicyRequest {
/**
* The name of the scaling policy. You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name.
*/
PolicyName: PolicyName;
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
/**
* The scaling policy type. This parameter is required if you are creating a scaling policy. The following policy types are supported: TargetTrackingScaling—Not supported for Amazon EMR. StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
*/
PolicyType?: PolicyType;
/**
* A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling.
*/
StepScalingPolicyConfiguration?: StepScalingPolicyConfiguration;
/**
* A target tracking scaling policy. Includes support for predefined or customized metrics. This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling.
*/
TargetTrackingScalingPolicyConfiguration?: TargetTrackingScalingPolicyConfiguration;
}
export interface PutScalingPolicyResponse {
/**
* The Amazon Resource Name (ARN) of the resulting scaling policy.
*/
PolicyARN: ResourceIdMaxLen1600;
/**
* The CloudWatch alarms created for the target tracking scaling policy.
*/
Alarms?: Alarms;
}
export interface PutScheduledActionRequest {
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The schedule for this action. The following formats are supported: At expressions - "at(yyyy-mm-ddThh:mm:ss)" Rate expressions - "rate(value unit)" Cron expressions - "cron(fields)" At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days. For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
*/
Schedule?: ResourceIdMaxLen1600;
/**
* Specifies the time zone used when setting a scheduled action by using an at or cron expression. If a time zone is not provided, UTC is used by default. Valid values are the canonical names of the IANA time zones supported by Joda-Time (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.
*/
Timezone?: ResourceIdMaxLen1600;
/**
* The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
*/
ScheduledActionName: ScheduledActionName;
/**
* The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
/**
* The date and time for this scheduled action to start, in UTC.
*/
StartTime?: TimestampType;
/**
* The date and time for the recurring schedule to end, in UTC.
*/
EndTime?: TimestampType;
/**
* The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
*/
ScalableTargetAction?: ScalableTargetAction;
}
export interface PutScheduledActionResponse {
}
export interface RegisterScalableTargetRequest {
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
/**
* The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target. For the following resources, the minimum value allowed is 0. AppStream 2.0 fleets Aurora DB clusters ECS services EMR clusters Lambda provisioned concurrency SageMaker endpoint variants SageMaker inference components SageMaker serverless endpoint provisioned concurrency Spot Fleets custom resources It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU utilization. For all other resources, the minimum allowed value depends on the type of resource that you are using. If you provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message will provide the minimum value that the resource can accept.
*/
MinCapacity?: ResourceCapacity;
/**
* The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target. Although you can specify a large maximum capacity, note that service quotas might impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference.
*/
MaxCapacity?: ResourceCapacity;
/**
* This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see How Application Auto Scaling works with IAM.
*/
RoleARN?: ResourceIdMaxLen1600;
/**
* An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. Suspension Outcomes For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. For more information, see Suspend and resume scaling in the Application Auto Scaling User Guide.
*/
SuspendedState?: SuspendedState;
/**
* Assigns one or more tags to the scalable target. Use this parameter to tag the scalable target when it is created. To tag an existing scalable target, use the TagResource operation. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have more than one tag on a scalable target with the same tag key. Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
*/
Tags?: TagMap;
}
export interface RegisterScalableTargetResponse {
/**
* The ARN of the scalable target.
*/
ScalableTargetARN?: XmlString;
}
export type ResourceCapacity = number;
export type ResourceId = string;
export type ResourceIdMaxLen1600 = string;
export type ResourceIdsMaxLen1600 = ResourceIdMaxLen1600[];
export type ResourceLabel = string;
export type ReturnData = boolean;
export type ScalableDimension = "ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"elasticmapreduce:instancegroup:InstanceCount"|"appstream:fleet:DesiredCapacity"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits"|"rds:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredInstanceCount"|"custom-resource:ResourceType:Property"|"comprehend:document-classifier-endpoint:DesiredInferenceUnits"|"comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"|"lambda:function:ProvisionedConcurrency"|"cassandra:table:ReadCapacityUnits"|"cassandra:table:WriteCapacityUnits"|"kafka:broker-storage:VolumeSize"|"elasticache:replication-group:NodeGroups"|"elasticache:replication-group:Replicas"|"neptune:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredProvisionedConcurrency"|"sagemaker:inference-component:DesiredCopyCount"|"workspaces:workspacespool:DesiredUserSessions"|string;
export interface ScalableTarget {
/**
* The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
/**
* The minimum value to scale to in response to a scale-in activity.
*/
MinCapacity: ResourceCapacity;
/**
* The maximum value to scale to in response to a scale-out activity.
*/
MaxCapacity: ResourceCapacity;
/**
* The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
*/
RoleARN: ResourceIdMaxLen1600;
/**
* The Unix timestamp for when the scalable target was created.
*/
CreationTime: TimestampType;
/**
* Specifies whether the scaling activities for a scalable target are in a suspended state.
*/
SuspendedState?: SuspendedState;
/**
* The ARN of the scalable target.
*/
ScalableTargetARN?: XmlString;
}
export interface ScalableTargetAction {
/**
* The minimum capacity. When the scheduled action runs, the resource will have at least this much capacity, but it might have more depending on other settings, such as the target utilization level of a target tracking scaling policy.
*/
MinCapacity?: ResourceCapacity;
/**
* The maximum capacity. Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference.
*/
MaxCapacity?: ResourceCapacity;
}
export type ScalableTargets = ScalableTarget[];
export type ScalingActivities = ScalingActivity[];
export interface ScalingActivity {
/**
* The unique identifier of the scaling activity.
*/
ActivityId: ResourceId;
/**
* The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
/**
* A simple description of what action the scaling activity intends to accomplish.
*/
Description: XmlString;
/**
* A simple description of what caused the scaling activity to happen.
*/
Cause: XmlString;
/**
* The Unix timestamp for when the scaling activity began.
*/
StartTime: TimestampType;
/**
* The Unix timestamp for when the scaling activity ended.
*/
EndTime?: TimestampType;
/**
* Indicates the status of the scaling activity.
*/
StatusCode: ScalingActivityStatusCode;
/**
* A simple message about the current status of the scaling activity.
*/
StatusMessage?: XmlString;
/**
* The details about the scaling activity.
*/
Details?: XmlString;
/**
* Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.
*/
NotScaledReasons?: NotScaledReasons;
}
export type ScalingActivityStatusCode = "Pending"|"InProgress"|"Successful"|"Overridden"|"Unfulfilled"|"Failed"|string;
export type ScalingAdjustment = number;
export type ScalingPolicies = ScalingPolicy[];
export interface ScalingPolicy {
/**
* The Amazon Resource Name (ARN) of the scaling policy.
*/
PolicyARN: ResourceIdMaxLen1600;
/**
* The name of the scaling policy.
*/
PolicyName: PolicyName;
/**
* The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
*/
ServiceNamespace: ServiceNamespace;
/**
* The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension: ScalableDimension;
/**
* The scaling policy type. The following policy types are supported: TargetTrackingScaling—Not supported for Amazon EMR StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
*/
PolicyType: PolicyType;
/**
* A step scaling policy.
*/
StepScalingPolicyConfiguration?: StepScalingPolicyConfiguration;
/**
* A target tracking scaling policy.
*/
TargetTrackingScalingPolicyConfiguration?: TargetTrackingScalingPolicyConfiguration;
/**
* The CloudWatch alarms associated with the scaling policy.
*/
Alarms?: Alarms;
/**
* The Unix timestamp for when the scaling policy was created.
*/
CreationTime: TimestampType;
}
export type ScalingSuspended = boolean;
export interface ScheduledAction {
/**
* The name of the scheduled action.
*/
ScheduledActionName: ScheduledActionName;
/**
* The Amazon Resource Name (ARN) of the scheduled action.
*/
ScheduledActionARN: ResourceIdMaxLen1600;
/**
* The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
*/
ServiceNamespace: ServiceNamespace;
/**
* The schedule for this action. The following formats are supported: At expressions - "at(yyyy-mm-ddThh:mm:ss)" Rate expressions - "rate(value unit)" Cron expressions - "cron(fields)" At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days. For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
*/
Schedule: ResourceIdMaxLen1600;
/**
* The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
*/
Timezone?: ResourceIdMaxLen1600;
/**
* The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property. ecs:service:DesiredCount - The task count of an ECS service. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
*/
ScalableDimension?: ScalableDimension;
/**
* The date and time that the action is scheduled to begin, in UTC.
*/
StartTime?: TimestampType;
/**
* The date and time that the action is scheduled to end, in UTC.
*/
EndTime?: TimestampType;
/**
* The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
*/
ScalableTargetAction?: ScalableTargetAction;
/**
* The date and time that the scheduled action was created.
*/
CreationTime: TimestampType;
}
export type ScheduledActionName = string;
export type ScheduledActions = ScheduledAction[];
export type ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|"comprehend"|"lambda"|"cassandra"|"kafka"|"elasticache"|"neptune"|"workspaces"|string;
export interface StepAdjustment {
/**
* The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it's exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
*/
MetricIntervalLowerBound?: MetricScale;
/**
* The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound.
*/
MetricIntervalUpperBound?: MetricScale;
/**
* The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.
*/
ScalingAdjustment: ScalingAdjustment;
}
export type StepAdjustments = StepAdjustment[];
export interface StepScalingPolicyConfiguration {
/**
* Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. AdjustmentType is required if you are adding a new step scaling policy configuration.
*/
AdjustmentType?: AdjustmentType;
/**
* A set of adjustments that enable you to scale based on the size of the alarm breach. At least one step adjustment is required if you are adding a new step scaling policy configuration.
*/
StepAdjustments?: StepAdjustments;
/**
* The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
*/
MinAdjustmentMagnitude?: MinAdjustmentMagnitude;
/**
* The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
*/
Cooldown?: Cooldown;
/**
* The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
*/
MetricAggregationType?: MetricAggregationType;
}
export interface SuspendedState {
/**
* Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
*/
DynamicScalingInSuspended?: ScalingSuspended;
/**
* Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
*/
DynamicScalingOutSuspended?: ScalingSuspended;
/**
* Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
*/
ScheduledScalingSuspended?: ScalingSuspended;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* Identifies the Application Auto Scaling scalable target that you want to apply tags to. For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 To get the ARN for a scalable target, use DescribeScalableTargets.
*/
ResourceARN: AmazonResourceName;
/**
* The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a tag key and a tag value. You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key. If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the current tag value with the specified one. For information about the rules that apply to tag keys and tag values, see User-defined tag restrictions in the Amazon Web Services Billing User Guide.
*/
Tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export interface TargetTrackingMetric {
/**
* The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
*/
Dimensions?: TargetTrackingMetricDimensions;
/**
* The name of the metric.
*/
MetricName?: TargetTrackingMetricName;
/**
* The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
*/
Namespace?: TargetTrackingMetricNamespace;
}
export type TargetTrackingMetricDataQueries = TargetTrackingMetricDataQuery[];
export interface TargetTrackingMetricDataQuery {
/**
* The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
*/
Expression?: Expression;
/**
* A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
*/
Id: Id;
/**
* A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
*/
Label?: XmlString;
/**
* Information about the metric data to return. Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
*/
MetricStat?: TargetTrackingMetricStat;
/**
* Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
*/
ReturnData?: ReturnData;
}
export interface TargetTrackingMetricDimension {
/**
* The name of the dimension.
*/
Name: TargetTrackingMetricDimensionName;
/**
* The value of the dimension.
*/
Value: TargetTrackingMetricDimensionValue;
}
export type TargetTrackingMetricDimensionName = string;
export type TargetTrackingMetricDimensionValue = string;
export type TargetTrackingMetricDimensions = TargetTrackingMetricDimension[];
export type TargetTrackingMetricName = string;
export type TargetTrackingMetricNamespace = string;
export interface TargetTrackingMetricStat {
/**
* The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
*/
Metric: TargetTrackingMetric;
/**
* The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average.
*/
Stat: XmlString;
/**
* The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
*/
Unit?: TargetTrackingMetricUnit;
}
export type TargetTrackingMetricUnit = string;
export interface TargetTrackingScalingPolicyConfiguration {
/**
* The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.
*/
TargetValue: MetricScale;
/**
* A predefined metric. You can specify either a predefined metric or a customized metric.
*/
PredefinedMetricSpecification?: PredefinedMetricSpecification;
/**
* A customized metric. You can specify either a predefined metric or a customized metric.
*/
CustomizedMetricSpecification?: CustomizedMetricSpecification;
/**
* The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
*/
ScaleOutCooldown?: Cooldown;
/**
* The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
*/
ScaleInCooldown?: Cooldown;
/**
* Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
*/
DisableScaleIn?: DisableScaleIn;
}
export type TimestampType = Date;
export interface UntagResourceRequest {
/**
* Identifies the Application Auto Scaling scalable target from which to remove tags. For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 To get the ARN for a scalable target, use DescribeScalableTargets.
*/
ResourceARN: AmazonResourceName;
/**
* One or more tag keys. Specify only the tag keys, not the tag values.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export type XmlString = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2016-02-06"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ApplicationAutoScaling client.
*/
export import Types = ApplicationAutoScaling;
}
export = ApplicationAutoScaling;
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['applicationautoscaling'] = {};
AWS.ApplicationAutoScaling = Service.defineService('applicationautoscaling', ['2016-02-06']);
Object.defineProperty(apiLoader.services['applicationautoscaling'], '2016-02-06', {
get: function get() {
var model = require('../apis/application-autoscaling-2016-02-06.min.json');
model.paginators = require('../apis/application-autoscaling-2016-02-06.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ApplicationAutoScaling;
@@ -0,0 +1,283 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ApplicationCostProfiler extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ApplicationCostProfiler.Types.ClientConfiguration)
config: Config & ApplicationCostProfiler.Types.ClientConfiguration;
/**
* Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated.
*/
deleteReportDefinition(params: ApplicationCostProfiler.Types.DeleteReportDefinitionRequest, callback?: (err: AWSError, data: ApplicationCostProfiler.Types.DeleteReportDefinitionResult) => void): Request<ApplicationCostProfiler.Types.DeleteReportDefinitionResult, AWSError>;
/**
* Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated.
*/
deleteReportDefinition(callback?: (err: AWSError, data: ApplicationCostProfiler.Types.DeleteReportDefinitionResult) => void): Request<ApplicationCostProfiler.Types.DeleteReportDefinitionResult, AWSError>;
/**
* Retrieves the definition of a report already configured in AWS Application Cost Profiler.
*/
getReportDefinition(params: ApplicationCostProfiler.Types.GetReportDefinitionRequest, callback?: (err: AWSError, data: ApplicationCostProfiler.Types.GetReportDefinitionResult) => void): Request<ApplicationCostProfiler.Types.GetReportDefinitionResult, AWSError>;
/**
* Retrieves the definition of a report already configured in AWS Application Cost Profiler.
*/
getReportDefinition(callback?: (err: AWSError, data: ApplicationCostProfiler.Types.GetReportDefinitionResult) => void): Request<ApplicationCostProfiler.Types.GetReportDefinitionResult, AWSError>;
/**
* Ingests application usage data from Amazon Simple Storage Service (Amazon S3). The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing asynchronously.
*/
importApplicationUsage(params: ApplicationCostProfiler.Types.ImportApplicationUsageRequest, callback?: (err: AWSError, data: ApplicationCostProfiler.Types.ImportApplicationUsageResult) => void): Request<ApplicationCostProfiler.Types.ImportApplicationUsageResult, AWSError>;
/**
* Ingests application usage data from Amazon Simple Storage Service (Amazon S3). The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing asynchronously.
*/
importApplicationUsage(callback?: (err: AWSError, data: ApplicationCostProfiler.Types.ImportApplicationUsageResult) => void): Request<ApplicationCostProfiler.Types.ImportApplicationUsageResult, AWSError>;
/**
* Retrieves a list of all reports and their configurations for your AWS account. The maximum number of reports is one.
*/
listReportDefinitions(params: ApplicationCostProfiler.Types.ListReportDefinitionsRequest, callback?: (err: AWSError, data: ApplicationCostProfiler.Types.ListReportDefinitionsResult) => void): Request<ApplicationCostProfiler.Types.ListReportDefinitionsResult, AWSError>;
/**
* Retrieves a list of all reports and their configurations for your AWS account. The maximum number of reports is one.
*/
listReportDefinitions(callback?: (err: AWSError, data: ApplicationCostProfiler.Types.ListReportDefinitionsResult) => void): Request<ApplicationCostProfiler.Types.ListReportDefinitionsResult, AWSError>;
/**
* Creates the report definition for a report in Application Cost Profiler.
*/
putReportDefinition(params: ApplicationCostProfiler.Types.PutReportDefinitionRequest, callback?: (err: AWSError, data: ApplicationCostProfiler.Types.PutReportDefinitionResult) => void): Request<ApplicationCostProfiler.Types.PutReportDefinitionResult, AWSError>;
/**
* Creates the report definition for a report in Application Cost Profiler.
*/
putReportDefinition(callback?: (err: AWSError, data: ApplicationCostProfiler.Types.PutReportDefinitionResult) => void): Request<ApplicationCostProfiler.Types.PutReportDefinitionResult, AWSError>;
/**
* Updates existing report in AWS Application Cost Profiler.
*/
updateReportDefinition(params: ApplicationCostProfiler.Types.UpdateReportDefinitionRequest, callback?: (err: AWSError, data: ApplicationCostProfiler.Types.UpdateReportDefinitionResult) => void): Request<ApplicationCostProfiler.Types.UpdateReportDefinitionResult, AWSError>;
/**
* Updates existing report in AWS Application Cost Profiler.
*/
updateReportDefinition(callback?: (err: AWSError, data: ApplicationCostProfiler.Types.UpdateReportDefinitionResult) => void): Request<ApplicationCostProfiler.Types.UpdateReportDefinitionResult, AWSError>;
}
declare namespace ApplicationCostProfiler {
export interface DeleteReportDefinitionRequest {
/**
* Required. ID of the report to delete.
*/
reportId: ReportId;
}
export interface DeleteReportDefinitionResult {
/**
* ID of the report that was deleted.
*/
reportId?: ReportId;
}
export type Format = "CSV"|"PARQUET"|string;
export interface GetReportDefinitionRequest {
/**
* ID of the report to retrieve.
*/
reportId: ReportId;
}
export interface GetReportDefinitionResult {
/**
* ID of the report retrieved.
*/
reportId: ReportId;
/**
* Description of the report.
*/
reportDescription: ReportDescription;
/**
* Cadence used to generate the report.
*/
reportFrequency: ReportFrequency;
/**
* Format of the generated report.
*/
format: Format;
/**
* Amazon Simple Storage Service (Amazon S3) location where the report is uploaded.
*/
destinationS3Location: S3Location;
/**
* Timestamp (milliseconds) when this report definition was created.
*/
createdAt: Timestamp;
/**
* Timestamp (milliseconds) when this report definition was last updated.
*/
lastUpdated: Timestamp;
}
export interface ImportApplicationUsageRequest {
/**
* Amazon S3 location to import application usage data from.
*/
sourceS3Location: SourceS3Location;
}
export interface ImportApplicationUsageResult {
/**
* ID of the import request.
*/
importId: ImportId;
}
export type ImportId = string;
export type Integer = number;
export interface ListReportDefinitionsRequest {
/**
* The token value from a previous call to access the next page of results.
*/
nextToken?: Token;
/**
* The maximum number of results to return.
*/
maxResults?: Integer;
}
export interface ListReportDefinitionsResult {
/**
* The retrieved reports.
*/
reportDefinitions?: ReportDefinitionList;
/**
* The value of the next token, if it exists. Null if there are no more results.
*/
nextToken?: Token;
}
export interface PutReportDefinitionRequest {
/**
* Required. ID of the report. You can choose any valid string matching the pattern for the ID.
*/
reportId: ReportId;
/**
* Required. Description of the report.
*/
reportDescription: ReportDescription;
/**
* Required. The cadence to generate the report.
*/
reportFrequency: ReportFrequency;
/**
* Required. The format to use for the generated report.
*/
format: Format;
/**
* Required. Amazon Simple Storage Service (Amazon S3) location where Application Cost Profiler uploads the report.
*/
destinationS3Location: S3Location;
}
export interface PutReportDefinitionResult {
/**
* ID of the report.
*/
reportId?: ReportId;
}
export interface ReportDefinition {
/**
* The ID of the report.
*/
reportId?: ReportId;
/**
* Description of the report
*/
reportDescription?: ReportDescription;
/**
* The cadence at which the report is generated.
*/
reportFrequency?: ReportFrequency;
/**
* The format used for the generated reports.
*/
format?: Format;
/**
* The location in Amazon Simple Storage Service (Amazon S3) the reports should be saved to.
*/
destinationS3Location?: S3Location;
/**
* Timestamp (milliseconds) when this report definition was created.
*/
createdAt?: Timestamp;
/**
* Timestamp (milliseconds) when this report definition was last updated.
*/
lastUpdatedAt?: Timestamp;
}
export type ReportDefinitionList = ReportDefinition[];
export type ReportDescription = string;
export type ReportFrequency = "MONTHLY"|"DAILY"|"ALL"|string;
export type ReportId = string;
export type S3Bucket = string;
export type S3BucketRegion = "ap-east-1"|"me-south-1"|"eu-south-1"|"af-south-1"|string;
export type S3Key = string;
export interface S3Location {
/**
* Name of the S3 bucket.
*/
bucket: S3Bucket;
/**
* Prefix for the location to write to.
*/
prefix: S3Prefix;
}
export type S3Prefix = string;
export interface SourceS3Location {
/**
* Name of the bucket.
*/
bucket: S3Bucket;
/**
* Key of the object.
*/
key: S3Key;
/**
* Region of the bucket. Only required for Regions that are disabled by default. For more infomration about Regions that are disabled by default, see Enabling a Region in the AWS General Reference guide.
*/
region?: S3BucketRegion;
}
export type Timestamp = Date;
export type Token = string;
export interface UpdateReportDefinitionRequest {
/**
* Required. ID of the report to update.
*/
reportId: ReportId;
/**
* Required. Description of the report.
*/
reportDescription: ReportDescription;
/**
* Required. The cadence to generate the report.
*/
reportFrequency: ReportFrequency;
/**
* Required. The format to use for the generated report.
*/
format: Format;
/**
* Required. Amazon Simple Storage Service (Amazon S3) location where Application Cost Profiler uploads the report.
*/
destinationS3Location: S3Location;
}
export interface UpdateReportDefinitionResult {
/**
* ID of the report.
*/
reportId?: ReportId;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2020-09-10"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ApplicationCostProfiler client.
*/
export import Types = ApplicationCostProfiler;
}
export = ApplicationCostProfiler;
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['applicationcostprofiler'] = {};
AWS.ApplicationCostProfiler = Service.defineService('applicationcostprofiler', ['2020-09-10']);
Object.defineProperty(apiLoader.services['applicationcostprofiler'], '2020-09-10', {
get: function get() {
var model = require('../apis/applicationcostprofiler-2020-09-10.min.json');
model.paginators = require('../apis/applicationcostprofiler-2020-09-10.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ApplicationCostProfiler;
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['applicationinsights'] = {};
AWS.ApplicationInsights = Service.defineService('applicationinsights', ['2018-11-25']);
Object.defineProperty(apiLoader.services['applicationinsights'], '2018-11-25', {
get: function get() {
var model = require('../apis/application-insights-2018-11-25.min.json');
model.paginators = require('../apis/application-insights-2018-11-25.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ApplicationInsights;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['applicationsignals'] = {};
AWS.ApplicationSignals = Service.defineService('applicationsignals', ['2024-04-15']);
Object.defineProperty(apiLoader.services['applicationsignals'], '2024-04-15', {
get: function get() {
var model = require('../apis/application-signals-2024-04-15.min.json');
model.paginators = require('../apis/application-signals-2024-04-15.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ApplicationSignals;
File diff suppressed because it is too large Load Diff
+27
View File
@@ -0,0 +1,27 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['appmesh'] = {};
AWS.AppMesh = Service.defineService('appmesh', ['2018-10-01', '2018-10-01*', '2019-01-25']);
Object.defineProperty(apiLoader.services['appmesh'], '2018-10-01', {
get: function get() {
var model = require('../apis/appmesh-2018-10-01.min.json');
model.paginators = require('../apis/appmesh-2018-10-01.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
Object.defineProperty(apiLoader.services['appmesh'], '2019-01-25', {
get: function get() {
var model = require('../apis/appmesh-2019-01-25.min.json');
model.paginators = require('../apis/appmesh-2019-01-25.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppMesh;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['apprunner'] = {};
AWS.AppRunner = Service.defineService('apprunner', ['2020-05-15']);
Object.defineProperty(apiLoader.services['apprunner'], '2020-05-15', {
get: function get() {
var model = require('../apis/apprunner-2020-05-15.min.json');
model.paginators = require('../apis/apprunner-2020-05-15.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppRunner;
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['appstream'] = {};
AWS.AppStream = Service.defineService('appstream', ['2016-12-01']);
Object.defineProperty(apiLoader.services['appstream'], '2016-12-01', {
get: function get() {
var model = require('../apis/appstream-2016-12-01.min.json');
model.paginators = require('../apis/appstream-2016-12-01.paginators.json').pagination;
model.waiters = require('../apis/appstream-2016-12-01.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppStream;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['appsync'] = {};
AWS.AppSync = Service.defineService('appsync', ['2017-07-25']);
Object.defineProperty(apiLoader.services['appsync'], '2017-07-25', {
get: function get() {
var model = require('../apis/appsync-2017-07-25.min.json');
model.paginators = require('../apis/appsync-2017-07-25.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppSync;
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['apptest'] = {};
AWS.AppTest = Service.defineService('apptest', ['2022-12-06']);
Object.defineProperty(apiLoader.services['apptest'], '2022-12-06', {
get: function get() {
var model = require('../apis/apptest-2022-12-06.min.json');
model.paginators = require('../apis/apptest-2022-12-06.paginators.json').pagination;
model.waiters = require('../apis/apptest-2022-12-06.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AppTest;
+646
View File
@@ -0,0 +1,646 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ARCZonalShift extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ARCZonalShift.Types.ClientConfiguration)
config: Config & ARCZonalShift.Types.ClientConfiguration;
/**
* Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID. A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.
*/
cancelZonalShift(params: ARCZonalShift.Types.CancelZonalShiftRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.ZonalShift) => void): Request<ARCZonalShift.Types.ZonalShift, AWSError>;
/**
* Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID. A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.
*/
cancelZonalShift(callback?: (err: AWSError, data: ARCZonalShift.Types.ZonalShift) => void): Request<ARCZonalShift.Types.ZonalShift, AWSError>;
/**
* A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting. When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application. For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
createPracticeRunConfiguration(params: ARCZonalShift.Types.CreatePracticeRunConfigurationRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.CreatePracticeRunConfigurationResponse) => void): Request<ARCZonalShift.Types.CreatePracticeRunConfigurationResponse, AWSError>;
/**
* A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting. When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application. For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
createPracticeRunConfiguration(callback?: (err: AWSError, data: ARCZonalShift.Types.CreatePracticeRunConfigurationResponse) => void): Request<ARCZonalShift.Types.CreatePracticeRunConfigurationResponse, AWSError>;
/**
* Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
*/
deletePracticeRunConfiguration(params: ARCZonalShift.Types.DeletePracticeRunConfigurationRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.DeletePracticeRunConfigurationResponse) => void): Request<ARCZonalShift.Types.DeletePracticeRunConfigurationResponse, AWSError>;
/**
* Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
*/
deletePracticeRunConfiguration(callback?: (err: AWSError, data: ARCZonalShift.Types.DeletePracticeRunConfigurationResponse) => void): Request<ARCZonalShift.Types.DeletePracticeRunConfigurationResponse, AWSError>;
/**
* Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
getAutoshiftObserverNotificationStatus(params: ARCZonalShift.Types.GetAutoshiftObserverNotificationStatusRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.GetAutoshiftObserverNotificationStatusResponse) => void): Request<ARCZonalShift.Types.GetAutoshiftObserverNotificationStatusResponse, AWSError>;
/**
* Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
getAutoshiftObserverNotificationStatus(callback?: (err: AWSError, data: ARCZonalShift.Types.GetAutoshiftObserverNotificationStatusResponse) => void): Request<ARCZonalShift.Types.GetAutoshiftObserverNotificationStatusResponse, AWSError>;
/**
* Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources. At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
*/
getManagedResource(params: ARCZonalShift.Types.GetManagedResourceRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.GetManagedResourceResponse) => void): Request<ARCZonalShift.Types.GetManagedResourceResponse, AWSError>;
/**
* Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources. At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
*/
getManagedResource(callback?: (err: AWSError, data: ARCZonalShift.Types.GetManagedResourceResponse) => void): Request<ARCZonalShift.Types.GetManagedResourceResponse, AWSError>;
/**
* Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.
*/
listAutoshifts(params: ARCZonalShift.Types.ListAutoshiftsRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.ListAutoshiftsResponse) => void): Request<ARCZonalShift.Types.ListAutoshiftsResponse, AWSError>;
/**
* Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.
*/
listAutoshifts(callback?: (err: AWSError, data: ARCZonalShift.Types.ListAutoshiftsResponse) => void): Request<ARCZonalShift.Types.ListAutoshiftsResponse, AWSError>;
/**
* Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
*/
listManagedResources(params: ARCZonalShift.Types.ListManagedResourcesRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.ListManagedResourcesResponse) => void): Request<ARCZonalShift.Types.ListManagedResourcesResponse, AWSError>;
/**
* Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
*/
listManagedResources(callback?: (err: AWSError, data: ARCZonalShift.Types.ListManagedResourcesResponse) => void): Request<ARCZonalShift.Types.ListManagedResourcesResponse, AWSError>;
/**
* Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift. The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see "&gt;ListAutoshifts.
*/
listZonalShifts(params: ARCZonalShift.Types.ListZonalShiftsRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.ListZonalShiftsResponse) => void): Request<ARCZonalShift.Types.ListZonalShiftsResponse, AWSError>;
/**
* Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift. The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see "&gt;ListAutoshifts.
*/
listZonalShifts(callback?: (err: AWSError, data: ARCZonalShift.Types.ListZonalShiftsResponse) => void): Request<ARCZonalShift.Types.ListZonalShiftsResponse, AWSError>;
/**
* You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services. At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off. When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete. For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
startZonalShift(params: ARCZonalShift.Types.StartZonalShiftRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.ZonalShift) => void): Request<ARCZonalShift.Types.ZonalShift, AWSError>;
/**
* You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services. At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off. When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete. For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
startZonalShift(callback?: (err: AWSError, data: ARCZonalShift.Types.ZonalShift) => void): Request<ARCZonalShift.Types.ZonalShift, AWSError>;
/**
* Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
updateAutoshiftObserverNotificationStatus(params: ARCZonalShift.Types.UpdateAutoshiftObserverNotificationStatusRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.UpdateAutoshiftObserverNotificationStatusResponse) => void): Request<ARCZonalShift.Types.UpdateAutoshiftObserverNotificationStatusResponse, AWSError>;
/**
* Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
updateAutoshiftObserverNotificationStatus(callback?: (err: AWSError, data: ARCZonalShift.Types.UpdateAutoshiftObserverNotificationStatusResponse) => void): Request<ARCZonalShift.Types.UpdateAutoshiftObserverNotificationStatusResponse, AWSError>;
/**
* Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
*/
updatePracticeRunConfiguration(params: ARCZonalShift.Types.UpdatePracticeRunConfigurationRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.UpdatePracticeRunConfigurationResponse) => void): Request<ARCZonalShift.Types.UpdatePracticeRunConfigurationResponse, AWSError>;
/**
* Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
*/
updatePracticeRunConfiguration(callback?: (err: AWSError, data: ARCZonalShift.Types.UpdatePracticeRunConfigurationResponse) => void): Request<ARCZonalShift.Types.UpdatePracticeRunConfigurationResponse, AWSError>;
/**
* The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone. You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.
*/
updateZonalAutoshiftConfiguration(params: ARCZonalShift.Types.UpdateZonalAutoshiftConfigurationRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.UpdateZonalAutoshiftConfigurationResponse) => void): Request<ARCZonalShift.Types.UpdateZonalAutoshiftConfigurationResponse, AWSError>;
/**
* The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone. You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.
*/
updateZonalAutoshiftConfiguration(callback?: (err: AWSError, data: ARCZonalShift.Types.UpdateZonalAutoshiftConfigurationResponse) => void): Request<ARCZonalShift.Types.UpdateZonalAutoshiftConfigurationResponse, AWSError>;
/**
* Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
*/
updateZonalShift(params: ARCZonalShift.Types.UpdateZonalShiftRequest, callback?: (err: AWSError, data: ARCZonalShift.Types.ZonalShift) => void): Request<ARCZonalShift.Types.ZonalShift, AWSError>;
/**
* Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
*/
updateZonalShift(callback?: (err: AWSError, data: ARCZonalShift.Types.ZonalShift) => void): Request<ARCZonalShift.Types.ZonalShift, AWSError>;
}
declare namespace ARCZonalShift {
export type AppliedStatus = "APPLIED"|"NOT_APPLIED"|string;
export type AppliedWeights = {[key: string]: Weight};
export type AutoshiftAppliedStatus = "APPLIED"|"NOT_APPLIED"|string;
export type AutoshiftExecutionStatus = "ACTIVE"|"COMPLETED"|string;
export interface AutoshiftInResource {
/**
* The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED. The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts &gt; autoshifts &gt; practice run zonal shifts. For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
appliedStatus: AutoshiftAppliedStatus;
/**
* The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.
*/
awayFrom: AvailabilityZone;
/**
* The time (UTC) when the autoshift started.
*/
startTime: StartTime;
}
export type AutoshiftObserverNotificationStatus = "ENABLED"|"DISABLED"|string;
export type AutoshiftSummaries = AutoshiftSummary[];
export interface AutoshiftSummary {
/**
* The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.
*/
awayFrom: AvailabilityZone;
/**
* The time (in UTC) when the autoshift ended.
*/
endTime: ExpiryTime;
/**
* The time (in UTC) when the autoshift started.
*/
startTime: StartTime;
/**
* The status for an autoshift.
*/
status: AutoshiftExecutionStatus;
}
export type AutoshiftsInResource = AutoshiftInResource[];
export type AvailabilityZone = string;
export type AvailabilityZones = AvailabilityZone[];
export type BlockedDate = string;
export type BlockedDates = BlockedDate[];
export type BlockedWindow = string;
export type BlockedWindows = BlockedWindow[];
export interface CancelZonalShiftRequest {
/**
* The internally-generated identifier of a zonal shift.
*/
zonalShiftId: ZonalShiftId;
}
export interface ControlCondition {
/**
* The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.
*/
alarmIdentifier: ResourceArn;
/**
* The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.
*/
type: ControlConditionType;
}
export type ControlConditionType = "CLOUDWATCH"|string;
export type ControlConditions = ControlCondition[];
export interface CreatePracticeRunConfigurationRequest {
/**
* Optionally, you can block Route 53 ARC from starting practice runs for a resource on specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces. For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
*/
blockedDates?: BlockedDates;
/**
* Optionally, you can block Route 53 ARC from starting practice runs for specific windows of days and times. The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces. For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
*/
blockedWindows?: BlockedWindows;
/**
* An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks Route 53 ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.
*/
blockingAlarms?: ControlConditions;
/**
* The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state. Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each weekly practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.
*/
outcomeAlarms: ControlConditions;
/**
* The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
*/
resourceIdentifier: ResourceIdentifier;
}
export interface CreatePracticeRunConfigurationResponse {
/**
* The Amazon Resource Name (ARN) of the resource that you configured the practice run for.
*/
arn: ResourceArn;
/**
* The name of the resource that you configured the practice run for.
*/
name: ResourceName;
/**
* A practice run configuration for a resource. Configurations include the outcome alarm that you specify for practice runs, and, optionally, a blocking alarm and blocking dates and windows.
*/
practiceRunConfiguration: PracticeRunConfiguration;
/**
* The status for zonal autoshift for a resource. When you specify ENABLED for the autoshift status, Amazon Web Services shifts traffic away from shifts away application resource traffic from an Availability Zone, on your behalf, when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers. When you enable zonal autoshift, you must also configure practice runs for the resource.
*/
zonalAutoshiftStatus: ZonalAutoshiftStatus;
}
export interface DeletePracticeRunConfigurationRequest {
/**
* The identifier for the resource that you want to delete the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
*/
resourceIdentifier: ResourceIdentifier;
}
export interface DeletePracticeRunConfigurationResponse {
/**
* The Amazon Resource Name (ARN) of the resource that you deleted the practice run for.
*/
arn: ResourceArn;
/**
* The name of the resource that you deleted the practice run for.
*/
name: ResourceName;
/**
* The status of zonal autoshift for the resource.
*/
zonalAutoshiftStatus: ZonalAutoshiftStatus;
}
export type ExpiresIn = string;
export type ExpiryTime = Date;
export interface GetAutoshiftObserverNotificationStatusRequest {
}
export interface GetAutoshiftObserverNotificationStatusResponse {
/**
* The status of autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
*/
status: AutoshiftObserverNotificationStatus;
}
export interface GetManagedResourceRequest {
/**
* The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
*/
resourceIdentifier: ResourceIdentifier;
}
export interface GetManagedResourceResponse {
/**
* A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.
*/
appliedWeights: AppliedWeights;
/**
* The Amazon Resource Name (ARN) for the resource.
*/
arn?: ResourceArn;
/**
* An array of the autoshifts that are active for the resource.
*/
autoshifts?: AutoshiftsInResource;
/**
* The name of the resource.
*/
name?: ResourceName;
/**
* The practice run configuration for zonal autoshift that's associated with the resource.
*/
practiceRunConfiguration?: PracticeRunConfiguration;
/**
* The status for zonal autoshift for a resource. When the autoshift status is ENABLED, Amazon Web Services shifts traffic for a resource away from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.
*/
zonalAutoshiftStatus?: ZonalAutoshiftStatus;
/**
* The zonal shifts that are currently active for a resource.
*/
zonalShifts: ZonalShiftsInResource;
}
export interface ListAutoshiftsRequest {
/**
* The number of objects that you want to return with this call.
*/
maxResults?: MaxResults;
/**
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
*/
nextToken?: String;
/**
* The status of the autoshift.
*/
status?: AutoshiftExecutionStatus;
}
export interface ListAutoshiftsResponse {
/**
* The items in the response list.
*/
items?: AutoshiftSummaries;
/**
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
*/
nextToken?: String;
}
export interface ListManagedResourcesRequest {
/**
* The number of objects that you want to return with this call.
*/
maxResults?: MaxResults;
/**
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
*/
nextToken?: String;
}
export interface ListManagedResourcesResponse {
/**
* The items in the response list.
*/
items: ManagedResourceSummaries;
/**
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
*/
nextToken?: String;
}
export interface ListZonalShiftsRequest {
/**
* The number of objects that you want to return with this call.
*/
maxResults?: MaxResults;
/**
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
*/
nextToken?: String;
/**
* The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource.
*/
resourceIdentifier?: ResourceIdentifier;
/**
* A status for a zonal shift. The Status for a zonal shift can have one of the following values: ACTIVE: The zonal shift has been started and active. EXPIRED: The zonal shift has expired (the expiry time was exceeded). CANCELED: The zonal shift was canceled.
*/
status?: ZonalShiftStatus;
}
export interface ListZonalShiftsResponse {
/**
* The items in the response list.
*/
items?: ZonalShiftSummaries;
/**
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
*/
nextToken?: String;
}
export type ManagedResourceSummaries = ManagedResourceSummary[];
export interface ManagedResourceSummary {
/**
* A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.
*/
appliedWeights?: AppliedWeights;
/**
* The Amazon Resource Name (ARN) for the managed resource.
*/
arn?: ResourceArn;
/**
* An array of the autoshifts that have been completed for a resource.
*/
autoshifts?: AutoshiftsInResource;
/**
* The Availability Zones that a resource is deployed in.
*/
availabilityZones: AvailabilityZones;
/**
* The name of the managed resource.
*/
name?: ResourceName;
/**
* This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, Route 53 ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53 ARC sets the value to DISABLED. Route 53 ARC updates this status; you can't set a practice run status to ENABLED or DISABLED.
*/
practiceRunStatus?: ZonalAutoshiftStatus;
/**
* The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED.
*/
zonalAutoshiftStatus?: ZonalAutoshiftStatus;
/**
* An array of the zonal shifts for a resource.
*/
zonalShifts?: ZonalShiftsInResource;
}
export type MaxResults = number;
export interface PracticeRunConfiguration {
/**
* An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource. Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.
*/
blockedDates?: BlockedDates;
/**
* An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource. Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.
*/
blockedWindows?: BlockedWindows;
/**
* The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.
*/
blockingAlarms?: ControlConditions;
/**
* The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.
*/
outcomeAlarms: ControlConditions;
}
export type PracticeRunOutcome = "FAILED"|"INTERRUPTED"|"PENDING"|"SUCCEEDED"|string;
export type ResourceArn = string;
export type ResourceIdentifier = string;
export type ResourceName = string;
export type StartTime = Date;
export interface StartZonalShiftRequest {
/**
* The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
*/
awayFrom: AvailabilityZone;
/**
* A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
*/
comment: ZonalShiftComment;
/**
* The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours). If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone. To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space: A lowercase letter m: To specify that the value is in minutes. A lowercase letter h: To specify that the value is in hours. For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).
*/
expiresIn: ExpiresIn;
/**
* The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
*/
resourceIdentifier: ResourceIdentifier;
}
export type String = string;
export interface UpdateAutoshiftObserverNotificationStatusRequest {
/**
* The status to set for autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
*/
status: AutoshiftObserverNotificationStatus;
}
export interface UpdateAutoshiftObserverNotificationStatusResponse {
/**
* The status for autoshift observer notification.
*/
status: AutoshiftObserverNotificationStatus;
}
export interface UpdatePracticeRunConfigurationRequest {
/**
* Add, change, or remove blocked dates for a practice run in zonal autoshift. Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces. For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
*/
blockedDates?: BlockedDates;
/**
* Add, change, or remove windows of days and times for when you can, optionally, block Route 53 ARC from starting a practice run for a resource. The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces. For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
*/
blockedWindows?: BlockedWindows;
/**
* Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.
*/
blockingAlarms?: ControlConditions;
/**
* Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.
*/
outcomeAlarms?: ControlConditions;
/**
* The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
*/
resourceIdentifier: ResourceIdentifier;
}
export interface UpdatePracticeRunConfigurationResponse {
/**
* The Amazon Resource Name (ARN) of the resource that you updated the practice run for.
*/
arn: ResourceArn;
/**
* The name of the resource that you updated the practice run for.
*/
name: ResourceName;
/**
* The practice run configuration that was updated.
*/
practiceRunConfiguration: PracticeRunConfiguration;
/**
* The zonal autoshift status for the resource that you updated the practice run for.
*/
zonalAutoshiftStatus: ZonalAutoshiftStatus;
}
export interface UpdateZonalAutoshiftConfigurationRequest {
/**
* The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
*/
resourceIdentifier: ResourceIdentifier;
/**
* The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for. Choose ENABLED to authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.
*/
zonalAutoshiftStatus: ZonalAutoshiftStatus;
}
export interface UpdateZonalAutoshiftConfigurationResponse {
/**
* The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
*/
resourceIdentifier: ResourceIdentifier;
/**
* The updated zonal autoshift status for the resource.
*/
zonalAutoshiftStatus: ZonalAutoshiftStatus;
}
export interface UpdateZonalShiftRequest {
/**
* A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
*/
comment?: ZonalShiftComment;
/**
* The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours). If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone. To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space: A lowercase letter m: To specify that the value is in minutes. A lowercase letter h: To specify that the value is in hours. For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).
*/
expiresIn?: ExpiresIn;
/**
* The identifier of a zonal shift.
*/
zonalShiftId: ZonalShiftId;
}
export type Weight = number;
export type ZonalAutoshiftStatus = "ENABLED"|"DISABLED"|string;
export interface ZonalShift {
/**
* The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
*/
awayFrom: AvailabilityZone;
/**
* A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
*/
comment: ZonalShiftComment;
/**
* The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time. When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
*/
expiryTime: ExpiryTime;
/**
* The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
*/
resourceIdentifier: ResourceIdentifier;
/**
* The time (UTC) when the zonal shift starts.
*/
startTime: StartTime;
/**
* A status for a zonal shift. The Status for a zonal shift can have one of the following values: ACTIVE: The zonal shift has been started and active. EXPIRED: The zonal shift has expired (the expiry time was exceeded). CANCELED: The zonal shift was canceled.
*/
status: ZonalShiftStatus;
/**
* The identifier of a zonal shift.
*/
zonalShiftId: ZonalShiftId;
}
export type ZonalShiftComment = string;
export type ZonalShiftId = string;
export interface ZonalShiftInResource {
/**
* The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED. The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts &gt; autoshifts &gt; practice run zonal shifts. For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
appliedStatus: AppliedStatus;
/**
* The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
*/
awayFrom: AvailabilityZone;
/**
* A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
*/
comment: ZonalShiftComment;
/**
* The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time. When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
*/
expiryTime: ExpiryTime;
/**
* The outcome, or end state, returned for a practice run. The following values can be returned: PENDING: Outcome value when a practice run is in progress. SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift. INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome. FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed. For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
practiceRunOutcome?: PracticeRunOutcome;
/**
* The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
*/
resourceIdentifier: ResourceIdentifier;
/**
* The time (UTC) when the zonal shift starts.
*/
startTime: StartTime;
/**
* The identifier of a zonal shift.
*/
zonalShiftId: ZonalShiftId;
}
export type ZonalShiftStatus = "ACTIVE"|"EXPIRED"|"CANCELED"|string;
export type ZonalShiftSummaries = ZonalShiftSummary[];
export interface ZonalShiftSummary {
/**
* The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
*/
awayFrom: AvailabilityZone;
/**
* A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
*/
comment: ZonalShiftComment;
/**
* The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time. When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
*/
expiryTime: ExpiryTime;
/**
* The outcome, or end state, of a practice run. The following values can be returned: PENDING: Outcome value when the practice run is in progress. SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed. INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome. FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed. For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
*/
practiceRunOutcome?: PracticeRunOutcome;
/**
* The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
*/
resourceIdentifier: ResourceIdentifier;
/**
* The time (UTC) when the zonal shift starts.
*/
startTime: StartTime;
/**
* A status for a zonal shift. The Status for a zonal shift can have one of the following values: ACTIVE: The zonal shift has been started and active. EXPIRED: The zonal shift has expired (the expiry time was exceeded). CANCELED: The zonal shift was canceled.
*/
status: ZonalShiftStatus;
/**
* The identifier of a zonal shift.
*/
zonalShiftId: ZonalShiftId;
}
export type ZonalShiftsInResource = ZonalShiftInResource[];
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2022-10-30"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ARCZonalShift client.
*/
export import Types = ARCZonalShift;
}
export = ARCZonalShift;
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['arczonalshift'] = {};
AWS.ARCZonalShift = Service.defineService('arczonalshift', ['2022-10-30']);
Object.defineProperty(apiLoader.services['arczonalshift'], '2022-10-30', {
get: function get() {
var model = require('../apis/arc-zonal-shift-2022-10-30.min.json');
model.paginators = require('../apis/arc-zonal-shift-2022-10-30.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ARCZonalShift;
+337
View File
@@ -0,0 +1,337 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Artifact extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Artifact.Types.ClientConfiguration)
config: Config & Artifact.Types.ClientConfiguration;
/**
* Get the account settings for Artifact.
*/
getAccountSettings(params: Artifact.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: Artifact.Types.GetAccountSettingsResponse) => void): Request<Artifact.Types.GetAccountSettingsResponse, AWSError>;
/**
* Get the account settings for Artifact.
*/
getAccountSettings(callback?: (err: AWSError, data: Artifact.Types.GetAccountSettingsResponse) => void): Request<Artifact.Types.GetAccountSettingsResponse, AWSError>;
/**
* Get the content for a single report.
*/
getReport(params: Artifact.Types.GetReportRequest, callback?: (err: AWSError, data: Artifact.Types.GetReportResponse) => void): Request<Artifact.Types.GetReportResponse, AWSError>;
/**
* Get the content for a single report.
*/
getReport(callback?: (err: AWSError, data: Artifact.Types.GetReportResponse) => void): Request<Artifact.Types.GetReportResponse, AWSError>;
/**
* Get the metadata for a single report.
*/
getReportMetadata(params: Artifact.Types.GetReportMetadataRequest, callback?: (err: AWSError, data: Artifact.Types.GetReportMetadataResponse) => void): Request<Artifact.Types.GetReportMetadataResponse, AWSError>;
/**
* Get the metadata for a single report.
*/
getReportMetadata(callback?: (err: AWSError, data: Artifact.Types.GetReportMetadataResponse) => void): Request<Artifact.Types.GetReportMetadataResponse, AWSError>;
/**
* Get the Term content associated with a single report.
*/
getTermForReport(params: Artifact.Types.GetTermForReportRequest, callback?: (err: AWSError, data: Artifact.Types.GetTermForReportResponse) => void): Request<Artifact.Types.GetTermForReportResponse, AWSError>;
/**
* Get the Term content associated with a single report.
*/
getTermForReport(callback?: (err: AWSError, data: Artifact.Types.GetTermForReportResponse) => void): Request<Artifact.Types.GetTermForReportResponse, AWSError>;
/**
* List available reports.
*/
listReports(params: Artifact.Types.ListReportsRequest, callback?: (err: AWSError, data: Artifact.Types.ListReportsResponse) => void): Request<Artifact.Types.ListReportsResponse, AWSError>;
/**
* List available reports.
*/
listReports(callback?: (err: AWSError, data: Artifact.Types.ListReportsResponse) => void): Request<Artifact.Types.ListReportsResponse, AWSError>;
/**
* Put the account settings for Artifact.
*/
putAccountSettings(params: Artifact.Types.PutAccountSettingsRequest, callback?: (err: AWSError, data: Artifact.Types.PutAccountSettingsResponse) => void): Request<Artifact.Types.PutAccountSettingsResponse, AWSError>;
/**
* Put the account settings for Artifact.
*/
putAccountSettings(callback?: (err: AWSError, data: Artifact.Types.PutAccountSettingsResponse) => void): Request<Artifact.Types.PutAccountSettingsResponse, AWSError>;
}
declare namespace Artifact {
export type AcceptanceType = "PASSTHROUGH"|"EXPLICIT"|string;
export interface AccountSettings {
/**
* Notification subscription status of the customer.
*/
notificationSubscriptionStatus?: NotificationSubscriptionStatus;
}
export interface GetAccountSettingsRequest {
}
export interface GetAccountSettingsResponse {
accountSettings?: AccountSettings;
}
export interface GetReportMetadataRequest {
/**
* Unique resource ID for the report resource.
*/
reportId: ReportId;
/**
* Version for the report resource.
*/
reportVersion?: VersionAttribute;
}
export interface GetReportMetadataResponse {
/**
* Report resource detail.
*/
reportDetails?: ReportDetail;
}
export interface GetReportRequest {
/**
* Unique resource ID for the report resource.
*/
reportId: ReportId;
/**
* Version for the report resource.
*/
reportVersion?: VersionAttribute;
/**
* Unique download token provided by GetTermForReport API.
*/
termToken: ShortStringAttribute;
}
export interface GetReportResponse {
/**
* Presigned S3 url to access the report content.
*/
documentPresignedUrl?: GetReportResponseDocumentPresignedUrlString;
}
export type GetReportResponseDocumentPresignedUrlString = string;
export interface GetTermForReportRequest {
/**
* Unique resource ID for the report resource.
*/
reportId: ReportId;
/**
* Version for the report resource.
*/
reportVersion?: VersionAttribute;
}
export interface GetTermForReportResponse {
/**
* Presigned S3 url to access the term content.
*/
documentPresignedUrl?: GetTermForReportResponseDocumentPresignedUrlString;
/**
* Unique token representing this request event.
*/
termToken?: String;
}
export type GetTermForReportResponseDocumentPresignedUrlString = string;
export interface ListReportsRequest {
/**
* Maximum number of resources to return in the paginated response.
*/
maxResults?: MaxResultsAttribute;
/**
* Pagination token to request the next page of resources.
*/
nextToken?: NextTokenAttribute;
}
export interface ListReportsResponse {
/**
* List of report resources.
*/
reports?: ReportsList;
/**
* Pagination token to request the next page of resources.
*/
nextToken?: NextTokenAttribute;
}
export type LongStringAttribute = string;
export type MaxResultsAttribute = number;
export type NextTokenAttribute = string;
export type NotificationSubscriptionStatus = "SUBSCRIBED"|"NOT_SUBSCRIBED"|string;
export type PublishedState = "PUBLISHED"|"UNPUBLISHED"|string;
export interface PutAccountSettingsRequest {
/**
* Desired notification subscription status.
*/
notificationSubscriptionStatus?: NotificationSubscriptionStatus;
}
export interface PutAccountSettingsResponse {
accountSettings?: AccountSettings;
}
export interface ReportDetail {
/**
* Unique resource ID for the report resource.
*/
id?: ReportId;
/**
* Name for the report resource.
*/
name?: ShortStringAttribute;
/**
* Description for the report resource.
*/
description?: LongStringAttribute;
/**
* Timestamp indicating the report resource effective start.
*/
periodStart?: TimestampAttribute;
/**
* Timestamp indicating the report resource effective end.
*/
periodEnd?: TimestampAttribute;
/**
* Timestamp indicating when the report resource was created.
*/
createdAt?: TimestampAttribute;
/**
* Timestamp indicating when the report resource was last modified.
*/
lastModifiedAt?: TimestampAttribute;
/**
* Timestamp indicating when the report resource was deleted.
*/
deletedAt?: TimestampAttribute;
/**
* Current state of the report resource
*/
state?: PublishedState;
/**
* ARN for the report resource.
*/
arn?: LongStringAttribute;
/**
* Series for the report resource.
*/
series?: ShortStringAttribute;
/**
* Category for the report resource.
*/
category?: ShortStringAttribute;
/**
* Associated company name for the report resource.
*/
companyName?: ShortStringAttribute;
/**
* Associated product name for the report resource.
*/
productName?: ShortStringAttribute;
/**
* Unique resource ARN for term resource.
*/
termArn?: LongStringAttribute;
/**
* Version for the report resource.
*/
version?: VersionAttribute;
/**
* Acceptance type for report.
*/
acceptanceType?: AcceptanceType;
/**
* Sequence number to enforce optimistic locking.
*/
sequenceNumber?: SequenceNumberAttribute;
/**
* The current state of the document upload.
*/
uploadState?: UploadState;
/**
* The message associated with the current upload state.
*/
statusMessage?: StatusMessage;
}
export type ReportId = string;
export interface ReportSummary {
/**
* Unique resource ID for the report resource.
*/
id?: ReportId;
/**
* Name for the report resource.
*/
name?: ShortStringAttribute;
/**
* Current state of the report resource.
*/
state?: PublishedState;
/**
* ARN for the report resource.
*/
arn?: LongStringAttribute;
/**
* Version for the report resource.
*/
version?: VersionAttribute;
/**
* The current state of the document upload.
*/
uploadState?: UploadState;
/**
* Description for the report resource.
*/
description?: LongStringAttribute;
/**
* Timestamp indicating the report resource effective start.
*/
periodStart?: TimestampAttribute;
/**
* Timestamp indicating the report resource effective end.
*/
periodEnd?: TimestampAttribute;
/**
* Series for the report resource.
*/
series?: ShortStringAttribute;
/**
* Category for the report resource.
*/
category?: ShortStringAttribute;
/**
* Associated company name for the report resource.
*/
companyName?: ShortStringAttribute;
/**
* Associated product name for the report resource.
*/
productName?: ShortStringAttribute;
/**
* The message associated with the current upload state.
*/
statusMessage?: StatusMessage;
/**
* Acceptance type for report.
*/
acceptanceType?: AcceptanceType;
}
export type ReportsList = ReportSummary[];
export type SequenceNumberAttribute = number;
export type ShortStringAttribute = string;
export type StatusMessage = string;
export type String = string;
export type TimestampAttribute = Date;
export type UploadState = "PROCESSING"|"COMPLETE"|"FAILED"|"FAULT"|string;
export type VersionAttribute = number;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-05-10"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Artifact client.
*/
export import Types = Artifact;
}
export = Artifact;
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['artifact'] = {};
AWS.Artifact = Service.defineService('artifact', ['2018-05-10']);
Object.defineProperty(apiLoader.services['artifact'], '2018-05-10', {
get: function get() {
var model = require('../apis/artifact-2018-05-10.min.json');
model.paginators = require('../apis/artifact-2018-05-10.paginators.json').pagination;
model.waiters = require('../apis/artifact-2018-05-10.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Artifact;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['athena'] = {};
AWS.Athena = Service.defineService('athena', ['2017-05-18']);
Object.defineProperty(apiLoader.services['athena'], '2017-05-18', {
get: function get() {
var model = require('../apis/athena-2017-05-18.min.json');
model.paginators = require('../apis/athena-2017-05-18.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Athena;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['auditmanager'] = {};
AWS.AuditManager = Service.defineService('auditmanager', ['2017-07-25']);
Object.defineProperty(apiLoader.services['auditmanager'], '2017-07-25', {
get: function get() {
var model = require('../apis/auditmanager-2017-07-25.min.json');
model.paginators = require('../apis/auditmanager-2017-07-25.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AuditManager;
@@ -0,0 +1,242 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class AugmentedAIRuntime extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AugmentedAIRuntime.Types.ClientConfiguration)
config: Config & AugmentedAIRuntime.Types.ClientConfiguration;
/**
* Deletes the specified human loop for a flow definition. If the human loop was deleted, this operation will return a ResourceNotFoundException.
*/
deleteHumanLoop(params: AugmentedAIRuntime.Types.DeleteHumanLoopRequest, callback?: (err: AWSError, data: AugmentedAIRuntime.Types.DeleteHumanLoopResponse) => void): Request<AugmentedAIRuntime.Types.DeleteHumanLoopResponse, AWSError>;
/**
* Deletes the specified human loop for a flow definition. If the human loop was deleted, this operation will return a ResourceNotFoundException.
*/
deleteHumanLoop(callback?: (err: AWSError, data: AugmentedAIRuntime.Types.DeleteHumanLoopResponse) => void): Request<AugmentedAIRuntime.Types.DeleteHumanLoopResponse, AWSError>;
/**
* Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.
*/
describeHumanLoop(params: AugmentedAIRuntime.Types.DescribeHumanLoopRequest, callback?: (err: AWSError, data: AugmentedAIRuntime.Types.DescribeHumanLoopResponse) => void): Request<AugmentedAIRuntime.Types.DescribeHumanLoopResponse, AWSError>;
/**
* Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.
*/
describeHumanLoop(callback?: (err: AWSError, data: AugmentedAIRuntime.Types.DescribeHumanLoopResponse) => void): Request<AugmentedAIRuntime.Types.DescribeHumanLoopResponse, AWSError>;
/**
* Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.
*/
listHumanLoops(params: AugmentedAIRuntime.Types.ListHumanLoopsRequest, callback?: (err: AWSError, data: AugmentedAIRuntime.Types.ListHumanLoopsResponse) => void): Request<AugmentedAIRuntime.Types.ListHumanLoopsResponse, AWSError>;
/**
* Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.
*/
listHumanLoops(callback?: (err: AWSError, data: AugmentedAIRuntime.Types.ListHumanLoopsResponse) => void): Request<AugmentedAIRuntime.Types.ListHumanLoopsResponse, AWSError>;
/**
* Starts a human loop, provided that at least one activation condition is met.
*/
startHumanLoop(params: AugmentedAIRuntime.Types.StartHumanLoopRequest, callback?: (err: AWSError, data: AugmentedAIRuntime.Types.StartHumanLoopResponse) => void): Request<AugmentedAIRuntime.Types.StartHumanLoopResponse, AWSError>;
/**
* Starts a human loop, provided that at least one activation condition is met.
*/
startHumanLoop(callback?: (err: AWSError, data: AugmentedAIRuntime.Types.StartHumanLoopResponse) => void): Request<AugmentedAIRuntime.Types.StartHumanLoopResponse, AWSError>;
/**
* Stops the specified human loop.
*/
stopHumanLoop(params: AugmentedAIRuntime.Types.StopHumanLoopRequest, callback?: (err: AWSError, data: AugmentedAIRuntime.Types.StopHumanLoopResponse) => void): Request<AugmentedAIRuntime.Types.StopHumanLoopResponse, AWSError>;
/**
* Stops the specified human loop.
*/
stopHumanLoop(callback?: (err: AWSError, data: AugmentedAIRuntime.Types.StopHumanLoopResponse) => void): Request<AugmentedAIRuntime.Types.StopHumanLoopResponse, AWSError>;
}
declare namespace AugmentedAIRuntime {
export type ContentClassifier = "FreeOfPersonallyIdentifiableInformation"|"FreeOfAdultContent"|string;
export type ContentClassifiers = ContentClassifier[];
export interface DeleteHumanLoopRequest {
/**
* The name of the human loop that you want to delete.
*/
HumanLoopName: HumanLoopName;
}
export interface DeleteHumanLoopResponse {
}
export interface DescribeHumanLoopRequest {
/**
* The name of the human loop that you want information about.
*/
HumanLoopName: HumanLoopName;
}
export interface DescribeHumanLoopResponse {
/**
* The creation time when Amazon Augmented AI created the human loop.
*/
CreationTime: Timestamp;
/**
* The reason why a human loop failed. The failure reason is returned when the status of the human loop is Failed.
*/
FailureReason?: String;
/**
* A failure code that identifies the type of failure. Possible values: ValidationError, Expired, InternalError
*/
FailureCode?: String;
/**
* The status of the human loop.
*/
HumanLoopStatus: HumanLoopStatus;
/**
* The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).
*/
HumanLoopName: HumanLoopName;
/**
* The Amazon Resource Name (ARN) of the human loop.
*/
HumanLoopArn: HumanLoopArn;
/**
* The Amazon Resource Name (ARN) of the flow definition.
*/
FlowDefinitionArn: FlowDefinitionArn;
/**
* An object that contains information about the output of the human loop.
*/
HumanLoopOutput?: HumanLoopOutput;
}
export type FailureReason = string;
export type FlowDefinitionArn = string;
export type HumanLoopArn = string;
export interface HumanLoopDataAttributes {
/**
* Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker can restrict the Amazon Mechanical Turk workers who can view your task based on this information.
*/
ContentClassifiers: ContentClassifiers;
}
export interface HumanLoopInput {
/**
* Serialized input from the human loop. The input must be a string representation of a file in JSON format.
*/
InputContent: InputContent;
}
export type HumanLoopName = string;
export interface HumanLoopOutput {
/**
* The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output.
*/
OutputS3Uri: String;
}
export type HumanLoopStatus = "InProgress"|"Failed"|"Completed"|"Stopped"|"Stopping"|string;
export type HumanLoopSummaries = HumanLoopSummary[];
export interface HumanLoopSummary {
/**
* The name of the human loop.
*/
HumanLoopName?: HumanLoopName;
/**
* The status of the human loop.
*/
HumanLoopStatus?: HumanLoopStatus;
/**
* When Amazon Augmented AI created the human loop.
*/
CreationTime?: Timestamp;
/**
* The reason why the human loop failed. A failure reason is returned when the status of the human loop is Failed.
*/
FailureReason?: FailureReason;
/**
* The Amazon Resource Name (ARN) of the flow definition used to configure the human loop.
*/
FlowDefinitionArn?: FlowDefinitionArn;
}
export type InputContent = string;
export interface ListHumanLoopsRequest {
/**
* (Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.
*/
CreationTimeAfter?: Timestamp;
/**
* (Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.
*/
CreationTimeBefore?: Timestamp;
/**
* The Amazon Resource Name (ARN) of a flow definition.
*/
FlowDefinitionArn: FlowDefinitionArn;
/**
* Optional. The order for displaying results. Valid values: Ascending and Descending.
*/
SortOrder?: SortOrder;
/**
* A token to display the next page of results.
*/
NextToken?: NextToken;
/**
* The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken is returned in the output. You can use this token to display the next page of results.
*/
MaxResults?: MaxResults;
}
export interface ListHumanLoopsResponse {
/**
* An array of objects that contain information about the human loops.
*/
HumanLoopSummaries: HumanLoopSummaries;
/**
* A token to display the next page of results.
*/
NextToken?: NextToken;
}
export type MaxResults = number;
export type NextToken = string;
export type SortOrder = "Ascending"|"Descending"|string;
export interface StartHumanLoopRequest {
/**
* The name of the human loop.
*/
HumanLoopName: HumanLoopName;
/**
* The Amazon Resource Name (ARN) of the flow definition associated with this human loop.
*/
FlowDefinitionArn: FlowDefinitionArn;
/**
* An object that contains information about the human loop.
*/
HumanLoopInput: HumanLoopInput;
/**
* Attributes of the specified data. Use DataAttributes to specify if your data is free of personally identifiable information and/or free of adult content.
*/
DataAttributes?: HumanLoopDataAttributes;
}
export interface StartHumanLoopResponse {
/**
* The Amazon Resource Name (ARN) of the human loop.
*/
HumanLoopArn?: HumanLoopArn;
}
export interface StopHumanLoopRequest {
/**
* The name of the human loop that you want to stop.
*/
HumanLoopName: HumanLoopName;
}
export interface StopHumanLoopResponse {
}
export type String = string;
export type Timestamp = Date;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-11-07"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the AugmentedAIRuntime client.
*/
export import Types = AugmentedAIRuntime;
}
export = AugmentedAIRuntime;
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['augmentedairuntime'] = {};
AWS.AugmentedAIRuntime = Service.defineService('augmentedairuntime', ['2019-11-07']);
Object.defineProperty(apiLoader.services['augmentedairuntime'], '2019-11-07', {
get: function get() {
var model = require('../apis/sagemaker-a2i-runtime-2019-11-07.min.json');
model.paginators = require('../apis/sagemaker-a2i-runtime-2019-11-07.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AugmentedAIRuntime;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['autoscaling'] = {};
AWS.AutoScaling = Service.defineService('autoscaling', ['2011-01-01']);
Object.defineProperty(apiLoader.services['autoscaling'], '2011-01-01', {
get: function get() {
var model = require('../apis/autoscaling-2011-01-01.min.json');
model.paginators = require('../apis/autoscaling-2011-01-01.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AutoScaling;
+551
View File
@@ -0,0 +1,551 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class AutoScalingPlans extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AutoScalingPlans.Types.ClientConfiguration)
config: Config & AutoScalingPlans.Types.ClientConfiguration;
/**
* Creates a scaling plan.
*/
createScalingPlan(params: AutoScalingPlans.Types.CreateScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.CreateScalingPlanResponse) => void): Request<AutoScalingPlans.Types.CreateScalingPlanResponse, AWSError>;
/**
* Creates a scaling plan.
*/
createScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.CreateScalingPlanResponse) => void): Request<AutoScalingPlans.Types.CreateScalingPlanResponse, AWSError>;
/**
* Deletes the specified scaling plan. Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan. If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.
*/
deleteScalingPlan(params: AutoScalingPlans.Types.DeleteScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DeleteScalingPlanResponse) => void): Request<AutoScalingPlans.Types.DeleteScalingPlanResponse, AWSError>;
/**
* Deletes the specified scaling plan. Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan. If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.
*/
deleteScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.DeleteScalingPlanResponse) => void): Request<AutoScalingPlans.Types.DeleteScalingPlanResponse, AWSError>;
/**
* Describes the scalable resources in the specified scaling plan.
*/
describeScalingPlanResources(params: AutoScalingPlans.Types.DescribeScalingPlanResourcesRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse) => void): Request<AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse, AWSError>;
/**
* Describes the scalable resources in the specified scaling plan.
*/
describeScalingPlanResources(callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse) => void): Request<AutoScalingPlans.Types.DescribeScalingPlanResourcesResponse, AWSError>;
/**
* Describes one or more of your scaling plans.
*/
describeScalingPlans(params: AutoScalingPlans.Types.DescribeScalingPlansRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlansResponse) => void): Request<AutoScalingPlans.Types.DescribeScalingPlansResponse, AWSError>;
/**
* Describes one or more of your scaling plans.
*/
describeScalingPlans(callback?: (err: AWSError, data: AutoScalingPlans.Types.DescribeScalingPlansResponse) => void): Request<AutoScalingPlans.Types.DescribeScalingPlansResponse, AWSError>;
/**
* Retrieves the forecast data for a scalable resource. Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.
*/
getScalingPlanResourceForecastData(params: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse) => void): Request<AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse, AWSError>;
/**
* Retrieves the forecast data for a scalable resource. Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.
*/
getScalingPlanResourceForecastData(callback?: (err: AWSError, data: AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse) => void): Request<AutoScalingPlans.Types.GetScalingPlanResourceForecastDataResponse, AWSError>;
/**
* Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
*/
updateScalingPlan(params: AutoScalingPlans.Types.UpdateScalingPlanRequest, callback?: (err: AWSError, data: AutoScalingPlans.Types.UpdateScalingPlanResponse) => void): Request<AutoScalingPlans.Types.UpdateScalingPlanResponse, AWSError>;
/**
* Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
*/
updateScalingPlan(callback?: (err: AWSError, data: AutoScalingPlans.Types.UpdateScalingPlanResponse) => void): Request<AutoScalingPlans.Types.UpdateScalingPlanResponse, AWSError>;
}
declare namespace AutoScalingPlans {
export interface ApplicationSource {
/**
* The Amazon Resource Name (ARN) of a AWS CloudFormation stack.
*/
CloudFormationStackARN?: XmlString;
/**
* A set of tags (up to 50).
*/
TagFilters?: TagFilters;
}
export type ApplicationSources = ApplicationSource[];
export type Cooldown = number;
export interface CreateScalingPlanRequest {
/**
* The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
*/
ScalingPlanName: ScalingPlanName;
/**
* A CloudFormation stack or set of tags. You can create one scaling plan per application source. For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
*/
ApplicationSource: ApplicationSource;
/**
* The scaling instructions. For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
*/
ScalingInstructions: ScalingInstructions;
}
export interface CreateScalingPlanResponse {
/**
* The version number of the scaling plan. This value is always 1. Currently, you cannot have multiple scaling plan versions.
*/
ScalingPlanVersion: ScalingPlanVersion;
}
export interface CustomizedLoadMetricSpecification {
/**
* The name of the metric.
*/
MetricName: MetricName;
/**
* The namespace of the metric.
*/
Namespace: MetricNamespace;
/**
* The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.
*/
Dimensions?: MetricDimensions;
/**
* The statistic of the metric. The only valid value is Sum.
*/
Statistic: MetricStatistic;
/**
* The unit of the metric.
*/
Unit?: MetricUnit;
}
export interface CustomizedScalingMetricSpecification {
/**
* The name of the metric.
*/
MetricName: MetricName;
/**
* The namespace of the metric.
*/
Namespace: MetricNamespace;
/**
* The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
*/
Dimensions?: MetricDimensions;
/**
* The statistic of the metric.
*/
Statistic: MetricStatistic;
/**
* The unit of the metric.
*/
Unit?: MetricUnit;
}
export interface Datapoint {
/**
* The time stamp for the data point in UTC format.
*/
Timestamp?: TimestampType;
/**
* The value of the data point.
*/
Value?: MetricScale;
}
export type Datapoints = Datapoint[];
export interface DeleteScalingPlanRequest {
/**
* The name of the scaling plan.
*/
ScalingPlanName: ScalingPlanName;
/**
* The version number of the scaling plan. Currently, the only valid value is 1.
*/
ScalingPlanVersion: ScalingPlanVersion;
}
export interface DeleteScalingPlanResponse {
}
export interface DescribeScalingPlanResourcesRequest {
/**
* The name of the scaling plan.
*/
ScalingPlanName: ScalingPlanName;
/**
* The version number of the scaling plan. Currently, the only valid value is 1.
*/
ScalingPlanVersion: ScalingPlanVersion;
/**
* The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeScalingPlanResourcesResponse {
/**
* Information about the scalable resources.
*/
ScalingPlanResources?: ScalingPlanResources;
/**
* The token required to get the next set of results. This value is null if there are no more results to return.
*/
NextToken?: NextToken;
}
export interface DescribeScalingPlansRequest {
/**
* The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.
*/
ScalingPlanNames?: ScalingPlanNames;
/**
* The version number of the scaling plan. Currently, the only valid value is 1. If you specify a scaling plan version, you must also specify a scaling plan name.
*/
ScalingPlanVersion?: ScalingPlanVersion;
/**
* The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.
*/
ApplicationSources?: ApplicationSources;
/**
* The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeScalingPlansResponse {
/**
* Information about the scaling plans.
*/
ScalingPlans?: ScalingPlans;
/**
* The token required to get the next set of results. This value is null if there are no more results to return.
*/
NextToken?: NextToken;
}
export type DisableDynamicScaling = boolean;
export type DisableScaleIn = boolean;
export type ForecastDataType = "CapacityForecast"|"LoadForecast"|"ScheduledActionMinCapacity"|"ScheduledActionMaxCapacity"|string;
export interface GetScalingPlanResourceForecastDataRequest {
/**
* The name of the scaling plan.
*/
ScalingPlanName: ScalingPlanName;
/**
* The version number of the scaling plan. Currently, the only valid value is 1.
*/
ScalingPlanVersion: ScalingPlanVersion;
/**
* The namespace of the AWS service. The only valid value is autoscaling.
*/
ServiceNamespace: ServiceNamespace;
/**
* The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
*/
ResourceId: XmlString;
/**
* The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
*/
ScalableDimension: ScalableDimension;
/**
* The type of forecast data to get. LoadForecast: The load metric forecast. CapacityForecast: The capacity forecast. ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction. ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.
*/
ForecastDataType: ForecastDataType;
/**
* The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.
*/
StartTime: TimestampType;
/**
* The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days. Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.
*/
EndTime: TimestampType;
}
export interface GetScalingPlanResourceForecastDataResponse {
/**
* The data points to return.
*/
Datapoints: Datapoints;
}
export type LoadMetricType = "ASGTotalCPUUtilization"|"ASGTotalNetworkIn"|"ASGTotalNetworkOut"|"ALBTargetGroupRequestCount"|string;
export type MaxResults = number;
export interface MetricDimension {
/**
* The name of the dimension.
*/
Name: MetricDimensionName;
/**
* The value of the dimension.
*/
Value: MetricDimensionValue;
}
export type MetricDimensionName = string;
export type MetricDimensionValue = string;
export type MetricDimensions = MetricDimension[];
export type MetricName = string;
export type MetricNamespace = string;
export type MetricScale = number;
export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string;
export type MetricUnit = string;
export type NextToken = string;
export type PolicyName = string;
export type PolicyType = "TargetTrackingScaling"|string;
export interface PredefinedLoadMetricSpecification {
/**
* The metric type.
*/
PredefinedLoadMetricType: LoadMetricType;
/**
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where: app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN. This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d. To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
*/
ResourceLabel?: ResourceLabel;
}
export interface PredefinedScalingMetricSpecification {
/**
* The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
*/
PredefinedScalingMetricType: ScalingMetricType;
/**
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where: app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN. This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d. To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
*/
ResourceLabel?: ResourceLabel;
}
export type PredictiveScalingMaxCapacityBehavior = "SetForecastCapacityToMaxCapacity"|"SetMaxCapacityToForecastCapacity"|"SetMaxCapacityAboveForecastCapacity"|string;
export type PredictiveScalingMode = "ForecastAndScale"|"ForecastOnly"|string;
export type ResourceCapacity = number;
export type ResourceIdMaxLen1600 = string;
export type ResourceLabel = string;
export type ScalableDimension = "autoscaling:autoScalingGroup:DesiredCapacity"|"ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"rds:cluster:ReadReplicaCount"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits"|string;
export interface ScalingInstruction {
/**
* The namespace of the AWS service.
*/
ServiceNamespace: ServiceNamespace;
/**
* The ID of the resource. This string consists of the resource type and unique identifier. Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension associated with the resource. autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*/
ScalableDimension: ScalableDimension;
/**
* The minimum capacity of the resource.
*/
MinCapacity: ResourceCapacity;
/**
* The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
*/
MaxCapacity: ResourceCapacity;
/**
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
*/
TargetTrackingConfigurations: TargetTrackingConfigurations;
/**
* The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
*/
PredefinedLoadMetricSpecification?: PredefinedLoadMetricSpecification;
/**
* The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
*/
CustomizedLoadMetricSpecification?: CustomizedLoadMetricSpecification;
/**
* The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. Only valid when configuring predictive scaling.
*/
ScheduledActionBufferTime?: ScheduledActionBufferTime;
/**
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity. The following are possible values: SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit. SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity. SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs. Only valid when configuring predictive scaling.
*/
PredictiveScalingMaxCapacityBehavior?: PredictiveScalingMaxCapacityBehavior;
/**
* The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise. The range is 1-100.
*/
PredictiveScalingMaxCapacityBuffer?: ResourceCapacity;
/**
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
*/
PredictiveScalingMode?: PredictiveScalingMode;
/**
* Controls whether a resource's externally created scaling policies are kept or replaced. The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created. Only valid when configuring dynamic scaling. Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.
*/
ScalingPolicyUpdateBehavior?: ScalingPolicyUpdateBehavior;
/**
* Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. The default is enabled (false).
*/
DisableDynamicScaling?: DisableDynamicScaling;
}
export type ScalingInstructions = ScalingInstruction[];
export type ScalingMetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|string;
export interface ScalingPlan {
/**
* The name of the scaling plan.
*/
ScalingPlanName: ScalingPlanName;
/**
* The version number of the scaling plan.
*/
ScalingPlanVersion: ScalingPlanVersion;
/**
* A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
*/
ApplicationSource: ApplicationSource;
/**
* The scaling instructions.
*/
ScalingInstructions: ScalingInstructions;
/**
* The status of the scaling plan. Active - The scaling plan is active. ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied. CreationInProgress - The scaling plan is being created. CreationFailed - The scaling plan could not be created. DeletionInProgress - The scaling plan is being deleted. DeletionFailed - The scaling plan could not be deleted. UpdateInProgress - The scaling plan is being updated. UpdateFailed - The scaling plan could not be updated.
*/
StatusCode: ScalingPlanStatusCode;
/**
* A simple message about the current status of the scaling plan.
*/
StatusMessage?: XmlString;
/**
* The Unix time stamp when the scaling plan entered the current status.
*/
StatusStartTime?: TimestampType;
/**
* The Unix time stamp when the scaling plan was created.
*/
CreationTime?: TimestampType;
}
export type ScalingPlanName = string;
export type ScalingPlanNames = ScalingPlanName[];
export interface ScalingPlanResource {
/**
* The name of the scaling plan.
*/
ScalingPlanName: ScalingPlanName;
/**
* The version number of the scaling plan.
*/
ScalingPlanVersion: ScalingPlanVersion;
/**
* The namespace of the AWS service.
*/
ServiceNamespace: ServiceNamespace;
/**
* The ID of the resource. This string consists of the resource type and unique identifier. Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index. Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
*/
ResourceId: ResourceIdMaxLen1600;
/**
* The scalable dimension for the resource. autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*/
ScalableDimension: ScalableDimension;
/**
* The scaling policies.
*/
ScalingPolicies?: ScalingPolicies;
/**
* The scaling status of the resource. Active - The scaling configuration is active. Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.
*/
ScalingStatusCode: ScalingStatusCode;
/**
* A simple message about the current scaling status of the resource.
*/
ScalingStatusMessage?: XmlString;
}
export type ScalingPlanResources = ScalingPlanResource[];
export type ScalingPlanStatusCode = "Active"|"ActiveWithProblems"|"CreationInProgress"|"CreationFailed"|"DeletionInProgress"|"DeletionFailed"|"UpdateInProgress"|"UpdateFailed"|string;
export type ScalingPlanVersion = number;
export type ScalingPlans = ScalingPlan[];
export type ScalingPolicies = ScalingPolicy[];
export interface ScalingPolicy {
/**
* The name of the scaling policy.
*/
PolicyName: PolicyName;
/**
* The type of scaling policy.
*/
PolicyType: PolicyType;
/**
* The target tracking scaling policy. Includes support for predefined or customized metrics.
*/
TargetTrackingConfiguration?: TargetTrackingConfiguration;
}
export type ScalingPolicyUpdateBehavior = "KeepExternalPolicies"|"ReplaceExternalPolicies"|string;
export type ScalingStatusCode = "Inactive"|"PartiallyActive"|"Active"|string;
export type ScheduledActionBufferTime = number;
export type ServiceNamespace = "autoscaling"|"ecs"|"ec2"|"rds"|"dynamodb"|string;
export interface TagFilter {
/**
* The tag key.
*/
Key?: XmlStringMaxLen128;
/**
* The tag values (0 to 20).
*/
Values?: TagValues;
}
export type TagFilters = TagFilter[];
export type TagValues = XmlStringMaxLen256[];
export interface TargetTrackingConfiguration {
/**
* A predefined metric. You can specify either a predefined metric or a customized metric.
*/
PredefinedScalingMetricSpecification?: PredefinedScalingMetricSpecification;
/**
* A customized metric. You can specify either a predefined metric or a customized metric.
*/
CustomizedScalingMetricSpecification?: CustomizedScalingMetricSpecification;
/**
* The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.
*/
TargetValue: MetricScale;
/**
* Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
*/
DisableScaleIn?: DisableScaleIn;
/**
* The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group. With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
*/
ScaleOutCooldown?: Cooldown;
/**
* The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group. With the scale-in cooldown period, the intention is to scale in conservatively to protect your applications availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
*/
ScaleInCooldown?: Cooldown;
/**
* The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
*/
EstimatedInstanceWarmup?: Cooldown;
}
export type TargetTrackingConfigurations = TargetTrackingConfiguration[];
export type TimestampType = Date;
export interface UpdateScalingPlanRequest {
/**
* The name of the scaling plan.
*/
ScalingPlanName: ScalingPlanName;
/**
* The version number of the scaling plan. The only valid value is 1. Currently, you cannot have multiple scaling plan versions.
*/
ScalingPlanVersion: ScalingPlanVersion;
/**
* A CloudFormation stack or set of tags. For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
*/
ApplicationSource?: ApplicationSource;
/**
* The scaling instructions. For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
*/
ScalingInstructions?: ScalingInstructions;
}
export interface UpdateScalingPlanResponse {
}
export type XmlString = string;
export type XmlStringMaxLen128 = string;
export type XmlStringMaxLen256 = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-01-06"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the AutoScalingPlans client.
*/
export import Types = AutoScalingPlans;
}
export = AutoScalingPlans;
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['autoscalingplans'] = {};
AWS.AutoScalingPlans = Service.defineService('autoscalingplans', ['2018-01-06']);
Object.defineProperty(apiLoader.services['autoscalingplans'], '2018-01-06', {
get: function get() {
var model = require('../apis/autoscaling-plans-2018-01-06.min.json');
model.paginators = require('../apis/autoscaling-plans-2018-01-06.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.AutoScalingPlans;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['b2bi'] = {};
AWS.B2bi = Service.defineService('b2bi', ['2022-06-23']);
Object.defineProperty(apiLoader.services['b2bi'], '2022-06-23', {
get: function get() {
var model = require('../apis/b2bi-2022-06-23.min.json');
model.paginators = require('../apis/b2bi-2022-06-23.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.B2bi;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['backup'] = {};
AWS.Backup = Service.defineService('backup', ['2018-11-15']);
Object.defineProperty(apiLoader.services['backup'], '2018-11-15', {
get: function get() {
var model = require('../apis/backup-2018-11-15.min.json');
model.paginators = require('../apis/backup-2018-11-15.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Backup;
+976
View File
@@ -0,0 +1,976 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class BackupGateway extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: BackupGateway.Types.ClientConfiguration)
config: Config & BackupGateway.Types.ClientConfiguration;
/**
* Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
*/
associateGatewayToServer(params: BackupGateway.Types.AssociateGatewayToServerInput, callback?: (err: AWSError, data: BackupGateway.Types.AssociateGatewayToServerOutput) => void): Request<BackupGateway.Types.AssociateGatewayToServerOutput, AWSError>;
/**
* Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
*/
associateGatewayToServer(callback?: (err: AWSError, data: BackupGateway.Types.AssociateGatewayToServerOutput) => void): Request<BackupGateway.Types.AssociateGatewayToServerOutput, AWSError>;
/**
* Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.
*/
createGateway(params: BackupGateway.Types.CreateGatewayInput, callback?: (err: AWSError, data: BackupGateway.Types.CreateGatewayOutput) => void): Request<BackupGateway.Types.CreateGatewayOutput, AWSError>;
/**
* Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.
*/
createGateway(callback?: (err: AWSError, data: BackupGateway.Types.CreateGatewayOutput) => void): Request<BackupGateway.Types.CreateGatewayOutput, AWSError>;
/**
* Deletes a backup gateway.
*/
deleteGateway(params: BackupGateway.Types.DeleteGatewayInput, callback?: (err: AWSError, data: BackupGateway.Types.DeleteGatewayOutput) => void): Request<BackupGateway.Types.DeleteGatewayOutput, AWSError>;
/**
* Deletes a backup gateway.
*/
deleteGateway(callback?: (err: AWSError, data: BackupGateway.Types.DeleteGatewayOutput) => void): Request<BackupGateway.Types.DeleteGatewayOutput, AWSError>;
/**
* Deletes a hypervisor.
*/
deleteHypervisor(params: BackupGateway.Types.DeleteHypervisorInput, callback?: (err: AWSError, data: BackupGateway.Types.DeleteHypervisorOutput) => void): Request<BackupGateway.Types.DeleteHypervisorOutput, AWSError>;
/**
* Deletes a hypervisor.
*/
deleteHypervisor(callback?: (err: AWSError, data: BackupGateway.Types.DeleteHypervisorOutput) => void): Request<BackupGateway.Types.DeleteHypervisorOutput, AWSError>;
/**
* Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.
*/
disassociateGatewayFromServer(params: BackupGateway.Types.DisassociateGatewayFromServerInput, callback?: (err: AWSError, data: BackupGateway.Types.DisassociateGatewayFromServerOutput) => void): Request<BackupGateway.Types.DisassociateGatewayFromServerOutput, AWSError>;
/**
* Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.
*/
disassociateGatewayFromServer(callback?: (err: AWSError, data: BackupGateway.Types.DisassociateGatewayFromServerOutput) => void): Request<BackupGateway.Types.DisassociateGatewayFromServerOutput, AWSError>;
/**
* Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.
*/
getBandwidthRateLimitSchedule(params: BackupGateway.Types.GetBandwidthRateLimitScheduleInput, callback?: (err: AWSError, data: BackupGateway.Types.GetBandwidthRateLimitScheduleOutput) => void): Request<BackupGateway.Types.GetBandwidthRateLimitScheduleOutput, AWSError>;
/**
* Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.
*/
getBandwidthRateLimitSchedule(callback?: (err: AWSError, data: BackupGateway.Types.GetBandwidthRateLimitScheduleOutput) => void): Request<BackupGateway.Types.GetBandwidthRateLimitScheduleOutput, AWSError>;
/**
* By providing the ARN (Amazon Resource Name), this API returns the gateway.
*/
getGateway(params: BackupGateway.Types.GetGatewayInput, callback?: (err: AWSError, data: BackupGateway.Types.GetGatewayOutput) => void): Request<BackupGateway.Types.GetGatewayOutput, AWSError>;
/**
* By providing the ARN (Amazon Resource Name), this API returns the gateway.
*/
getGateway(callback?: (err: AWSError, data: BackupGateway.Types.GetGatewayOutput) => void): Request<BackupGateway.Types.GetGatewayOutput, AWSError>;
/**
* This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
*/
getHypervisor(params: BackupGateway.Types.GetHypervisorInput, callback?: (err: AWSError, data: BackupGateway.Types.GetHypervisorOutput) => void): Request<BackupGateway.Types.GetHypervisorOutput, AWSError>;
/**
* This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
*/
getHypervisor(callback?: (err: AWSError, data: BackupGateway.Types.GetHypervisorOutput) => void): Request<BackupGateway.Types.GetHypervisorOutput, AWSError>;
/**
* This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
*/
getHypervisorPropertyMappings(params: BackupGateway.Types.GetHypervisorPropertyMappingsInput, callback?: (err: AWSError, data: BackupGateway.Types.GetHypervisorPropertyMappingsOutput) => void): Request<BackupGateway.Types.GetHypervisorPropertyMappingsOutput, AWSError>;
/**
* This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
*/
getHypervisorPropertyMappings(callback?: (err: AWSError, data: BackupGateway.Types.GetHypervisorPropertyMappingsOutput) => void): Request<BackupGateway.Types.GetHypervisorPropertyMappingsOutput, AWSError>;
/**
* By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
*/
getVirtualMachine(params: BackupGateway.Types.GetVirtualMachineInput, callback?: (err: AWSError, data: BackupGateway.Types.GetVirtualMachineOutput) => void): Request<BackupGateway.Types.GetVirtualMachineOutput, AWSError>;
/**
* By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
*/
getVirtualMachine(callback?: (err: AWSError, data: BackupGateway.Types.GetVirtualMachineOutput) => void): Request<BackupGateway.Types.GetVirtualMachineOutput, AWSError>;
/**
* Connect to a hypervisor by importing its configuration.
*/
importHypervisorConfiguration(params: BackupGateway.Types.ImportHypervisorConfigurationInput, callback?: (err: AWSError, data: BackupGateway.Types.ImportHypervisorConfigurationOutput) => void): Request<BackupGateway.Types.ImportHypervisorConfigurationOutput, AWSError>;
/**
* Connect to a hypervisor by importing its configuration.
*/
importHypervisorConfiguration(callback?: (err: AWSError, data: BackupGateway.Types.ImportHypervisorConfigurationOutput) => void): Request<BackupGateway.Types.ImportHypervisorConfigurationOutput, AWSError>;
/**
* Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
*/
listGateways(params: BackupGateway.Types.ListGatewaysInput, callback?: (err: AWSError, data: BackupGateway.Types.ListGatewaysOutput) => void): Request<BackupGateway.Types.ListGatewaysOutput, AWSError>;
/**
* Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
*/
listGateways(callback?: (err: AWSError, data: BackupGateway.Types.ListGatewaysOutput) => void): Request<BackupGateway.Types.ListGatewaysOutput, AWSError>;
/**
* Lists your hypervisors.
*/
listHypervisors(params: BackupGateway.Types.ListHypervisorsInput, callback?: (err: AWSError, data: BackupGateway.Types.ListHypervisorsOutput) => void): Request<BackupGateway.Types.ListHypervisorsOutput, AWSError>;
/**
* Lists your hypervisors.
*/
listHypervisors(callback?: (err: AWSError, data: BackupGateway.Types.ListHypervisorsOutput) => void): Request<BackupGateway.Types.ListHypervisorsOutput, AWSError>;
/**
* Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
*/
listTagsForResource(params: BackupGateway.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: BackupGateway.Types.ListTagsForResourceOutput) => void): Request<BackupGateway.Types.ListTagsForResourceOutput, AWSError>;
/**
* Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
*/
listTagsForResource(callback?: (err: AWSError, data: BackupGateway.Types.ListTagsForResourceOutput) => void): Request<BackupGateway.Types.ListTagsForResourceOutput, AWSError>;
/**
* Lists your virtual machines.
*/
listVirtualMachines(params: BackupGateway.Types.ListVirtualMachinesInput, callback?: (err: AWSError, data: BackupGateway.Types.ListVirtualMachinesOutput) => void): Request<BackupGateway.Types.ListVirtualMachinesOutput, AWSError>;
/**
* Lists your virtual machines.
*/
listVirtualMachines(callback?: (err: AWSError, data: BackupGateway.Types.ListVirtualMachinesOutput) => void): Request<BackupGateway.Types.ListVirtualMachinesOutput, AWSError>;
/**
* This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.
*/
putBandwidthRateLimitSchedule(params: BackupGateway.Types.PutBandwidthRateLimitScheduleInput, callback?: (err: AWSError, data: BackupGateway.Types.PutBandwidthRateLimitScheduleOutput) => void): Request<BackupGateway.Types.PutBandwidthRateLimitScheduleOutput, AWSError>;
/**
* This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.
*/
putBandwidthRateLimitSchedule(callback?: (err: AWSError, data: BackupGateway.Types.PutBandwidthRateLimitScheduleOutput) => void): Request<BackupGateway.Types.PutBandwidthRateLimitScheduleOutput, AWSError>;
/**
* This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
*/
putHypervisorPropertyMappings(params: BackupGateway.Types.PutHypervisorPropertyMappingsInput, callback?: (err: AWSError, data: BackupGateway.Types.PutHypervisorPropertyMappingsOutput) => void): Request<BackupGateway.Types.PutHypervisorPropertyMappingsOutput, AWSError>;
/**
* This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
*/
putHypervisorPropertyMappings(callback?: (err: AWSError, data: BackupGateway.Types.PutHypervisorPropertyMappingsOutput) => void): Request<BackupGateway.Types.PutHypervisorPropertyMappingsOutput, AWSError>;
/**
* Set the maintenance start time for a gateway.
*/
putMaintenanceStartTime(params: BackupGateway.Types.PutMaintenanceStartTimeInput, callback?: (err: AWSError, data: BackupGateway.Types.PutMaintenanceStartTimeOutput) => void): Request<BackupGateway.Types.PutMaintenanceStartTimeOutput, AWSError>;
/**
* Set the maintenance start time for a gateway.
*/
putMaintenanceStartTime(callback?: (err: AWSError, data: BackupGateway.Types.PutMaintenanceStartTimeOutput) => void): Request<BackupGateway.Types.PutMaintenanceStartTimeOutput, AWSError>;
/**
* This action sends a request to sync metadata across the specified virtual machines.
*/
startVirtualMachinesMetadataSync(params: BackupGateway.Types.StartVirtualMachinesMetadataSyncInput, callback?: (err: AWSError, data: BackupGateway.Types.StartVirtualMachinesMetadataSyncOutput) => void): Request<BackupGateway.Types.StartVirtualMachinesMetadataSyncOutput, AWSError>;
/**
* This action sends a request to sync metadata across the specified virtual machines.
*/
startVirtualMachinesMetadataSync(callback?: (err: AWSError, data: BackupGateway.Types.StartVirtualMachinesMetadataSyncOutput) => void): Request<BackupGateway.Types.StartVirtualMachinesMetadataSyncOutput, AWSError>;
/**
* Tag the resource.
*/
tagResource(params: BackupGateway.Types.TagResourceInput, callback?: (err: AWSError, data: BackupGateway.Types.TagResourceOutput) => void): Request<BackupGateway.Types.TagResourceOutput, AWSError>;
/**
* Tag the resource.
*/
tagResource(callback?: (err: AWSError, data: BackupGateway.Types.TagResourceOutput) => void): Request<BackupGateway.Types.TagResourceOutput, AWSError>;
/**
* Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
*/
testHypervisorConfiguration(params: BackupGateway.Types.TestHypervisorConfigurationInput, callback?: (err: AWSError, data: BackupGateway.Types.TestHypervisorConfigurationOutput) => void): Request<BackupGateway.Types.TestHypervisorConfigurationOutput, AWSError>;
/**
* Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
*/
testHypervisorConfiguration(callback?: (err: AWSError, data: BackupGateway.Types.TestHypervisorConfigurationOutput) => void): Request<BackupGateway.Types.TestHypervisorConfigurationOutput, AWSError>;
/**
* Removes tags from the resource.
*/
untagResource(params: BackupGateway.Types.UntagResourceInput, callback?: (err: AWSError, data: BackupGateway.Types.UntagResourceOutput) => void): Request<BackupGateway.Types.UntagResourceOutput, AWSError>;
/**
* Removes tags from the resource.
*/
untagResource(callback?: (err: AWSError, data: BackupGateway.Types.UntagResourceOutput) => void): Request<BackupGateway.Types.UntagResourceOutput, AWSError>;
/**
* Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
*/
updateGatewayInformation(params: BackupGateway.Types.UpdateGatewayInformationInput, callback?: (err: AWSError, data: BackupGateway.Types.UpdateGatewayInformationOutput) => void): Request<BackupGateway.Types.UpdateGatewayInformationOutput, AWSError>;
/**
* Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
*/
updateGatewayInformation(callback?: (err: AWSError, data: BackupGateway.Types.UpdateGatewayInformationOutput) => void): Request<BackupGateway.Types.UpdateGatewayInformationOutput, AWSError>;
/**
* Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.
*/
updateGatewaySoftwareNow(params: BackupGateway.Types.UpdateGatewaySoftwareNowInput, callback?: (err: AWSError, data: BackupGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request<BackupGateway.Types.UpdateGatewaySoftwareNowOutput, AWSError>;
/**
* Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.
*/
updateGatewaySoftwareNow(callback?: (err: AWSError, data: BackupGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request<BackupGateway.Types.UpdateGatewaySoftwareNowOutput, AWSError>;
/**
* Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.
*/
updateHypervisor(params: BackupGateway.Types.UpdateHypervisorInput, callback?: (err: AWSError, data: BackupGateway.Types.UpdateHypervisorOutput) => void): Request<BackupGateway.Types.UpdateHypervisorOutput, AWSError>;
/**
* Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.
*/
updateHypervisor(callback?: (err: AWSError, data: BackupGateway.Types.UpdateHypervisorOutput) => void): Request<BackupGateway.Types.UpdateHypervisorOutput, AWSError>;
}
declare namespace BackupGateway {
export type ActivationKey = string;
export interface AssociateGatewayToServerInput {
/**
* The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
*/
GatewayArn: GatewayArn;
/**
* The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
*/
ServerArn: ServerArn;
}
export interface AssociateGatewayToServerOutput {
/**
* The Amazon Resource Name (ARN) of a gateway.
*/
GatewayArn?: GatewayArn;
}
export type AverageUploadRateLimit = number;
export interface BandwidthRateLimitInterval {
/**
* The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set. For Backup Gateway, the minimum value is (Value).
*/
AverageUploadRateLimitInBitsPerSec?: AverageUploadRateLimit;
/**
* The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
*/
DaysOfWeek: DaysOfWeek;
/**
* The hour of the day to end the bandwidth rate limit interval.
*/
EndHourOfDay: HourOfDay;
/**
* The minute of the hour to end the bandwidth rate limit interval. The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.
*/
EndMinuteOfHour: MinuteOfHour;
/**
* The hour of the day to start the bandwidth rate limit interval.
*/
StartHourOfDay: HourOfDay;
/**
* The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.
*/
StartMinuteOfHour: MinuteOfHour;
}
export type BandwidthRateLimitIntervals = BandwidthRateLimitInterval[];
export interface CreateGatewayInput {
/**
* The activation key of the created gateway.
*/
ActivationKey: ActivationKey;
/**
* The display name of the created gateway.
*/
GatewayDisplayName: Name;
/**
* The type of created gateway.
*/
GatewayType: GatewayType;
/**
* A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
*/
Tags?: Tags;
}
export interface CreateGatewayOutput {
/**
* The Amazon Resource Name (ARN) of the gateway you create.
*/
GatewayArn?: GatewayArn;
}
export type DayOfMonth = number;
export type DayOfWeek = number;
export type DaysOfWeek = DayOfWeek[];
export interface DeleteGatewayInput {
/**
* The Amazon Resource Name (ARN) of the gateway to delete.
*/
GatewayArn: GatewayArn;
}
export interface DeleteGatewayOutput {
/**
* The Amazon Resource Name (ARN) of the gateway you deleted.
*/
GatewayArn?: GatewayArn;
}
export interface DeleteHypervisorInput {
/**
* The Amazon Resource Name (ARN) of the hypervisor to delete.
*/
HypervisorArn: ServerArn;
}
export interface DeleteHypervisorOutput {
/**
* The Amazon Resource Name (ARN) of the hypervisor you deleted.
*/
HypervisorArn?: ServerArn;
}
export interface DisassociateGatewayFromServerInput {
/**
* The Amazon Resource Name (ARN) of the gateway to disassociate.
*/
GatewayArn: GatewayArn;
}
export interface DisassociateGatewayFromServerOutput {
/**
* The Amazon Resource Name (ARN) of the gateway you disassociated.
*/
GatewayArn?: GatewayArn;
}
export interface Gateway {
/**
* The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
*/
GatewayArn?: GatewayArn;
/**
* The display name of the gateway.
*/
GatewayDisplayName?: Name;
/**
* The type of the gateway.
*/
GatewayType?: GatewayType;
/**
* The hypervisor ID of the gateway.
*/
HypervisorId?: HypervisorId;
/**
* The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
*/
LastSeenTime?: Time;
}
export type GatewayArn = string;
export interface GatewayDetails {
/**
* The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
*/
GatewayArn?: GatewayArn;
/**
* The display name of the gateway.
*/
GatewayDisplayName?: Name;
/**
* The type of the gateway type.
*/
GatewayType?: GatewayType;
/**
* The hypervisor ID of the gateway.
*/
HypervisorId?: HypervisorId;
/**
* Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.
*/
LastSeenTime?: Time;
/**
* Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.
*/
MaintenanceStartTime?: MaintenanceStartTime;
/**
* Details showing the next update availability time of the gateway.
*/
NextUpdateAvailabilityTime?: Time;
/**
* The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.
*/
VpcEndpoint?: VpcEndpoint;
}
export type GatewayType = "BACKUP_VM"|string;
export type Gateways = Gateway[];
export interface GetBandwidthRateLimitScheduleInput {
/**
* The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
*/
GatewayArn: GatewayArn;
}
export interface GetBandwidthRateLimitScheduleOutput {
/**
* An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
*/
BandwidthRateLimitIntervals?: BandwidthRateLimitIntervals;
/**
* The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
*/
GatewayArn?: GatewayArn;
}
export interface GetGatewayInput {
/**
* The Amazon Resource Name (ARN) of the gateway.
*/
GatewayArn: GatewayArn;
}
export interface GetGatewayOutput {
/**
* By providing the ARN (Amazon Resource Name), this API returns the gateway.
*/
Gateway?: GatewayDetails;
}
export interface GetHypervisorInput {
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn: ServerArn;
}
export interface GetHypervisorOutput {
/**
* Details about the requested hypervisor.
*/
Hypervisor?: HypervisorDetails;
}
export interface GetHypervisorPropertyMappingsInput {
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn: ServerArn;
}
export interface GetHypervisorPropertyMappingsOutput {
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn?: ServerArn;
/**
* The Amazon Resource Name (ARN) of the IAM role.
*/
IamRoleArn?: IamRoleArn;
/**
* This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.
*/
VmwareToAwsTagMappings?: VmwareToAwsTagMappings;
}
export interface GetVirtualMachineInput {
/**
* The Amazon Resource Name (ARN) of the virtual machine.
*/
ResourceArn: ResourceArn;
}
export interface GetVirtualMachineOutput {
/**
* This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine
*/
VirtualMachine?: VirtualMachineDetails;
}
export type Host = string;
export type HourOfDay = number;
export interface Hypervisor {
/**
* The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
*/
Host?: Host;
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn?: ServerArn;
/**
* The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.
*/
KmsKeyArn?: KmsKeyArn;
/**
* The name of the hypervisor.
*/
Name?: Name;
/**
* The state of the hypervisor.
*/
State?: HypervisorState;
}
export interface HypervisorDetails {
/**
* The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
*/
Host?: Host;
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn?: ServerArn;
/**
* The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor.
*/
KmsKeyArn?: KmsKeyArn;
/**
* This is the time when the most recent successful sync of metadata occurred.
*/
LastSuccessfulMetadataSyncTime?: Time;
/**
* This is the most recent status for the indicated metadata sync.
*/
LatestMetadataSyncStatus?: SyncMetadataStatus;
/**
* This is the most recent status for the indicated metadata sync.
*/
LatestMetadataSyncStatusMessage?: string;
/**
* The Amazon Resource Name (ARN) of the group of gateways within the requested log.
*/
LogGroupArn?: LogGroupArn;
/**
* This is the name of the specified hypervisor.
*/
Name?: Name;
/**
* This is the current state of the specified hypervisor. The possible states are PENDING, ONLINE, OFFLINE, or ERROR.
*/
State?: HypervisorState;
}
export type HypervisorId = string;
export type HypervisorState = "PENDING"|"ONLINE"|"OFFLINE"|"ERROR"|string;
export type Hypervisors = Hypervisor[];
export type IamRoleArn = string;
export interface ImportHypervisorConfigurationInput {
/**
* The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
*/
Host: Host;
/**
* The Key Management Service for the hypervisor.
*/
KmsKeyArn?: KmsKeyArn;
/**
* The name of the hypervisor.
*/
Name: Name;
/**
* The password for the hypervisor.
*/
Password?: Password;
/**
* The tags of the hypervisor configuration to import.
*/
Tags?: Tags;
/**
* The username for the hypervisor.
*/
Username?: Username;
}
export interface ImportHypervisorConfigurationOutput {
/**
* The Amazon Resource Name (ARN) of the hypervisor you disassociated.
*/
HypervisorArn?: ServerArn;
}
export type KmsKeyArn = string;
export interface ListGatewaysInput {
/**
* The maximum number of gateways to list.
*/
MaxResults?: MaxResults;
/**
* The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: NextToken;
}
export interface ListGatewaysOutput {
/**
* A list of your gateways.
*/
Gateways?: Gateways;
/**
* The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: NextToken;
}
export interface ListHypervisorsInput {
/**
* The maximum number of hypervisors to list.
*/
MaxResults?: MaxResults;
/**
* The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: NextToken;
}
export interface ListHypervisorsOutput {
/**
* A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).
*/
Hypervisors?: Hypervisors;
/**
* The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: NextToken;
}
export interface ListTagsForResourceInput {
/**
* The Amazon Resource Name (ARN) of the resource's tags to list.
*/
ResourceArn: ResourceArn;
}
export interface ListTagsForResourceOutput {
/**
* The Amazon Resource Name (ARN) of the resource's tags that you listed.
*/
ResourceArn?: ResourceArn;
/**
* A list of the resource's tags.
*/
Tags?: Tags;
}
export interface ListVirtualMachinesInput {
/**
* The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
*/
HypervisorArn?: ServerArn;
/**
* The maximum number of virtual machines to list.
*/
MaxResults?: MaxResults;
/**
* The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: NextToken;
}
export interface ListVirtualMachinesOutput {
/**
* The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: NextToken;
/**
* A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).
*/
VirtualMachines?: VirtualMachines;
}
export type LogGroupArn = string;
export interface MaintenanceStartTime {
/**
* The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
*/
DayOfMonth?: DayOfMonth;
/**
* An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.
*/
DayOfWeek?: DayOfWeek;
/**
* The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
*/
HourOfDay: HourOfDay;
/**
* The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.
*/
MinuteOfHour: MinuteOfHour;
}
export type MaxResults = number;
export type MinuteOfHour = number;
export type Name = string;
export type NextToken = string;
export type Password = string;
export type Path = string;
export interface PutBandwidthRateLimitScheduleInput {
/**
* An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
*/
BandwidthRateLimitIntervals: BandwidthRateLimitIntervals;
/**
* The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
*/
GatewayArn: GatewayArn;
}
export interface PutBandwidthRateLimitScheduleOutput {
/**
* The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
*/
GatewayArn?: GatewayArn;
}
export interface PutHypervisorPropertyMappingsInput {
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn: ServerArn;
/**
* The Amazon Resource Name (ARN) of the IAM role.
*/
IamRoleArn: IamRoleArn;
/**
* This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.
*/
VmwareToAwsTagMappings: VmwareToAwsTagMappings;
}
export interface PutHypervisorPropertyMappingsOutput {
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn?: ServerArn;
}
export interface PutMaintenanceStartTimeInput {
/**
* The day of the month start maintenance on a gateway. Valid values range from Sunday to Saturday.
*/
DayOfMonth?: DayOfMonth;
/**
* The day of the week to start maintenance on a gateway.
*/
DayOfWeek?: DayOfWeek;
/**
* The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.
*/
GatewayArn: GatewayArn;
/**
* The hour of the day to start maintenance on a gateway.
*/
HourOfDay: HourOfDay;
/**
* The minute of the hour to start maintenance on a gateway.
*/
MinuteOfHour: MinuteOfHour;
}
export interface PutMaintenanceStartTimeOutput {
/**
* The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.
*/
GatewayArn?: GatewayArn;
}
export type ResourceArn = string;
export type ServerArn = string;
export interface StartVirtualMachinesMetadataSyncInput {
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn: ServerArn;
}
export interface StartVirtualMachinesMetadataSyncOutput {
/**
* The Amazon Resource Name (ARN) of the hypervisor.
*/
HypervisorArn?: ServerArn;
}
export type SyncMetadataStatus = "CREATED"|"RUNNING"|"FAILED"|"PARTIALLY_FAILED"|"SUCCEEDED"|string;
export interface Tag {
/**
* The key part of a tag's key-value pair. The key can't start with aws:.
*/
Key: TagKey;
/**
* The value part of a tag's key-value pair.
*/
Value: TagValue;
}
export type TagKey = string;
export type TagKeys = TagKey[];
export interface TagResourceInput {
/**
* The Amazon Resource Name (ARN) of the resource to tag.
*/
ResourceARN: ResourceArn;
/**
* A list of tags to assign to the resource.
*/
Tags: Tags;
}
export interface TagResourceOutput {
/**
* The Amazon Resource Name (ARN) of the resource you tagged.
*/
ResourceARN?: ResourceArn;
}
export type TagValue = string;
export type Tags = Tag[];
export interface TestHypervisorConfigurationInput {
/**
* The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
*/
GatewayArn: GatewayArn;
/**
* The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
*/
Host: Host;
/**
* The password for the hypervisor.
*/
Password?: Password;
/**
* The username for the hypervisor.
*/
Username?: Username;
}
export interface TestHypervisorConfigurationOutput {
}
export type Time = Date;
export interface UntagResourceInput {
/**
* The Amazon Resource Name (ARN) of the resource from which to remove tags.
*/
ResourceARN: ResourceArn;
/**
* The list of tag keys specifying which tags to remove.
*/
TagKeys: TagKeys;
}
export interface UntagResourceOutput {
/**
* The Amazon Resource Name (ARN) of the resource from which you removed tags.
*/
ResourceARN?: ResourceArn;
}
export interface UpdateGatewayInformationInput {
/**
* The Amazon Resource Name (ARN) of the gateway to update.
*/
GatewayArn: GatewayArn;
/**
* The updated display name of the gateway.
*/
GatewayDisplayName?: Name;
}
export interface UpdateGatewayInformationOutput {
/**
* The Amazon Resource Name (ARN) of the gateway you updated.
*/
GatewayArn?: GatewayArn;
}
export interface UpdateGatewaySoftwareNowInput {
/**
* The Amazon Resource Name (ARN) of the gateway to be updated.
*/
GatewayArn: GatewayArn;
}
export interface UpdateGatewaySoftwareNowOutput {
/**
* The Amazon Resource Name (ARN) of the gateway you updated.
*/
GatewayArn?: GatewayArn;
}
export interface UpdateHypervisorInput {
/**
* The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
*/
Host?: Host;
/**
* The Amazon Resource Name (ARN) of the hypervisor to update.
*/
HypervisorArn: ServerArn;
/**
* The Amazon Resource Name (ARN) of the group of gateways within the requested log.
*/
LogGroupArn?: LogGroupArn;
/**
* The updated name for the hypervisor
*/
Name?: Name;
/**
* The updated password for the hypervisor.
*/
Password?: Password;
/**
* The updated username for the hypervisor.
*/
Username?: Username;
}
export interface UpdateHypervisorOutput {
/**
* The Amazon Resource Name (ARN) of the hypervisor you updated.
*/
HypervisorArn?: ServerArn;
}
export type Username = string;
export interface VirtualMachine {
/**
* The host name of the virtual machine.
*/
HostName?: Name;
/**
* The ID of the virtual machine's hypervisor.
*/
HypervisorId?: string;
/**
* The most recent date a virtual machine was backed up, in Unix format and UTC time.
*/
LastBackupDate?: Time;
/**
* The name of the virtual machine.
*/
Name?: Name;
/**
* The path of the virtual machine.
*/
Path?: Path;
/**
* The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.
*/
ResourceArn?: ResourceArn;
}
export interface VirtualMachineDetails {
/**
* The host name of the virtual machine.
*/
HostName?: Name;
/**
* The ID of the virtual machine's hypervisor.
*/
HypervisorId?: string;
/**
* The most recent date a virtual machine was backed up, in Unix format and UTC time.
*/
LastBackupDate?: Time;
/**
* The name of the virtual machine.
*/
Name?: Name;
/**
* The path of the virtual machine.
*/
Path?: Path;
/**
* The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.
*/
ResourceArn?: ResourceArn;
/**
* These are the details of the VMware tags associated with the specified virtual machine.
*/
VmwareTags?: VmwareTags;
}
export type VirtualMachines = VirtualMachine[];
export type VmwareCategory = string;
export interface VmwareTag {
/**
* The is the category of VMware.
*/
VmwareCategory?: VmwareCategory;
/**
* This is a user-defined description of a VMware tag.
*/
VmwareTagDescription?: string;
/**
* This is the user-defined name of a VMware tag.
*/
VmwareTagName?: VmwareTagName;
}
export type VmwareTagName = string;
export type VmwareTags = VmwareTag[];
export interface VmwareToAwsTagMapping {
/**
* The key part of the Amazon Web Services tag's key-value pair.
*/
AwsTagKey: TagKey;
/**
* The value part of the Amazon Web Services tag's key-value pair.
*/
AwsTagValue: TagValue;
/**
* The is the category of VMware.
*/
VmwareCategory: VmwareCategory;
/**
* This is the user-defined name of a VMware tag.
*/
VmwareTagName: VmwareTagName;
}
export type VmwareToAwsTagMappings = VmwareToAwsTagMapping[];
export type VpcEndpoint = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2021-01-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the BackupGateway client.
*/
export import Types = BackupGateway;
}
export = BackupGateway;
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['backupgateway'] = {};
AWS.BackupGateway = Service.defineService('backupgateway', ['2021-01-01']);
Object.defineProperty(apiLoader.services['backupgateway'], '2021-01-01', {
get: function get() {
var model = require('../apis/backup-gateway-2021-01-01.min.json');
model.paginators = require('../apis/backup-gateway-2021-01-01.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.BackupGateway;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['batch'] = {};
AWS.Batch = Service.defineService('batch', ['2016-08-10']);
Object.defineProperty(apiLoader.services['batch'], '2016-08-10', {
get: function get() {
var model = require('../apis/batch-2016-08-10.min.json');
model.paginators = require('../apis/batch-2016-08-10.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Batch;
+589
View File
@@ -0,0 +1,589 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class BCMDataExports extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: BCMDataExports.Types.ClientConfiguration)
config: Config & BCMDataExports.Types.ClientConfiguration;
/**
* Creates a data export and specifies the data query, the delivery preference, and any optional resource tags. A DataQuery consists of both a QueryStatement and TableConfigurations. The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary. The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.
*/
createExport(params: BCMDataExports.Types.CreateExportRequest, callback?: (err: AWSError, data: BCMDataExports.Types.CreateExportResponse) => void): Request<BCMDataExports.Types.CreateExportResponse, AWSError>;
/**
* Creates a data export and specifies the data query, the delivery preference, and any optional resource tags. A DataQuery consists of both a QueryStatement and TableConfigurations. The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary. The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.
*/
createExport(callback?: (err: AWSError, data: BCMDataExports.Types.CreateExportResponse) => void): Request<BCMDataExports.Types.CreateExportResponse, AWSError>;
/**
* Deletes an existing data export.
*/
deleteExport(params: BCMDataExports.Types.DeleteExportRequest, callback?: (err: AWSError, data: BCMDataExports.Types.DeleteExportResponse) => void): Request<BCMDataExports.Types.DeleteExportResponse, AWSError>;
/**
* Deletes an existing data export.
*/
deleteExport(callback?: (err: AWSError, data: BCMDataExports.Types.DeleteExportResponse) => void): Request<BCMDataExports.Types.DeleteExportResponse, AWSError>;
/**
* Exports data based on the source data update.
*/
getExecution(params: BCMDataExports.Types.GetExecutionRequest, callback?: (err: AWSError, data: BCMDataExports.Types.GetExecutionResponse) => void): Request<BCMDataExports.Types.GetExecutionResponse, AWSError>;
/**
* Exports data based on the source data update.
*/
getExecution(callback?: (err: AWSError, data: BCMDataExports.Types.GetExecutionResponse) => void): Request<BCMDataExports.Types.GetExecutionResponse, AWSError>;
/**
* Views the definition of an existing data export.
*/
getExport(params: BCMDataExports.Types.GetExportRequest, callback?: (err: AWSError, data: BCMDataExports.Types.GetExportResponse) => void): Request<BCMDataExports.Types.GetExportResponse, AWSError>;
/**
* Views the definition of an existing data export.
*/
getExport(callback?: (err: AWSError, data: BCMDataExports.Types.GetExportResponse) => void): Request<BCMDataExports.Types.GetExportResponse, AWSError>;
/**
* Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.
*/
getTable(params: BCMDataExports.Types.GetTableRequest, callback?: (err: AWSError, data: BCMDataExports.Types.GetTableResponse) => void): Request<BCMDataExports.Types.GetTableResponse, AWSError>;
/**
* Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.
*/
getTable(callback?: (err: AWSError, data: BCMDataExports.Types.GetTableResponse) => void): Request<BCMDataExports.Types.GetTableResponse, AWSError>;
/**
* Lists the historical executions for the export.
*/
listExecutions(params: BCMDataExports.Types.ListExecutionsRequest, callback?: (err: AWSError, data: BCMDataExports.Types.ListExecutionsResponse) => void): Request<BCMDataExports.Types.ListExecutionsResponse, AWSError>;
/**
* Lists the historical executions for the export.
*/
listExecutions(callback?: (err: AWSError, data: BCMDataExports.Types.ListExecutionsResponse) => void): Request<BCMDataExports.Types.ListExecutionsResponse, AWSError>;
/**
* Lists all data export definitions.
*/
listExports(params: BCMDataExports.Types.ListExportsRequest, callback?: (err: AWSError, data: BCMDataExports.Types.ListExportsResponse) => void): Request<BCMDataExports.Types.ListExportsResponse, AWSError>;
/**
* Lists all data export definitions.
*/
listExports(callback?: (err: AWSError, data: BCMDataExports.Types.ListExportsResponse) => void): Request<BCMDataExports.Types.ListExportsResponse, AWSError>;
/**
* Lists all available tables in data exports.
*/
listTables(params: BCMDataExports.Types.ListTablesRequest, callback?: (err: AWSError, data: BCMDataExports.Types.ListTablesResponse) => void): Request<BCMDataExports.Types.ListTablesResponse, AWSError>;
/**
* Lists all available tables in data exports.
*/
listTables(callback?: (err: AWSError, data: BCMDataExports.Types.ListTablesResponse) => void): Request<BCMDataExports.Types.ListTablesResponse, AWSError>;
/**
* List tags associated with an existing data export.
*/
listTagsForResource(params: BCMDataExports.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: BCMDataExports.Types.ListTagsForResourceResponse) => void): Request<BCMDataExports.Types.ListTagsForResourceResponse, AWSError>;
/**
* List tags associated with an existing data export.
*/
listTagsForResource(callback?: (err: AWSError, data: BCMDataExports.Types.ListTagsForResourceResponse) => void): Request<BCMDataExports.Types.ListTagsForResourceResponse, AWSError>;
/**
* Adds tags for an existing data export definition.
*/
tagResource(params: BCMDataExports.Types.TagResourceRequest, callback?: (err: AWSError, data: BCMDataExports.Types.TagResourceResponse) => void): Request<BCMDataExports.Types.TagResourceResponse, AWSError>;
/**
* Adds tags for an existing data export definition.
*/
tagResource(callback?: (err: AWSError, data: BCMDataExports.Types.TagResourceResponse) => void): Request<BCMDataExports.Types.TagResourceResponse, AWSError>;
/**
* Deletes tags associated with an existing data export definition.
*/
untagResource(params: BCMDataExports.Types.UntagResourceRequest, callback?: (err: AWSError, data: BCMDataExports.Types.UntagResourceResponse) => void): Request<BCMDataExports.Types.UntagResourceResponse, AWSError>;
/**
* Deletes tags associated with an existing data export definition.
*/
untagResource(callback?: (err: AWSError, data: BCMDataExports.Types.UntagResourceResponse) => void): Request<BCMDataExports.Types.UntagResourceResponse, AWSError>;
/**
* Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.
*/
updateExport(params: BCMDataExports.Types.UpdateExportRequest, callback?: (err: AWSError, data: BCMDataExports.Types.UpdateExportResponse) => void): Request<BCMDataExports.Types.UpdateExportResponse, AWSError>;
/**
* Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.
*/
updateExport(callback?: (err: AWSError, data: BCMDataExports.Types.UpdateExportResponse) => void): Request<BCMDataExports.Types.UpdateExportResponse, AWSError>;
}
declare namespace BCMDataExports {
export type Arn = string;
export interface Column {
/**
* The description for a column.
*/
Description?: GenericString;
/**
* The column name.
*/
Name?: GenericString;
/**
* The kind of data a column stores.
*/
Type?: GenericString;
}
export type ColumnList = Column[];
export type CompressionOption = "GZIP"|"PARQUET"|string;
export interface CreateExportRequest {
/**
* The details of the export, including data query, name, description, and destination configuration.
*/
Export: Export;
/**
* An optional list of tags to associate with the specified export. Each tag consists of a key and a value, and each key must be unique for the resource.
*/
ResourceTags?: ResourceTagList;
}
export interface CreateExportResponse {
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn?: Arn;
}
export interface DataQuery {
/**
* The query statement.
*/
QueryStatement: QueryStatement;
/**
* The table configuration.
*/
TableConfigurations?: TableConfigurations;
}
export interface DeleteExportRequest {
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn: Arn;
}
export interface DeleteExportResponse {
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn?: Arn;
}
export interface DestinationConfigurations {
/**
* An object that describes the destination of the data exports file.
*/
S3Destination: S3Destination;
}
export interface ExecutionReference {
/**
* The ID for this specific execution.
*/
ExecutionId: GenericString;
/**
* The status of this specific execution.
*/
ExecutionStatus: ExecutionStatus;
}
export type ExecutionReferenceList = ExecutionReference[];
export interface ExecutionStatus {
/**
* The time when the execution was completed.
*/
CompletedAt?: SyntheticTimestamp_date_time;
/**
* The time when the execution was created.
*/
CreatedAt?: SyntheticTimestamp_date_time;
/**
* The time when the execution was last updated.
*/
LastUpdatedAt?: SyntheticTimestamp_date_time;
/**
* The code for the status of the execution.
*/
StatusCode?: ExecutionStatusCode;
/**
* The reason for the failed status.
*/
StatusReason?: ExecutionStatusReason;
}
export type ExecutionStatusCode = "INITIATION_IN_PROCESS"|"QUERY_QUEUED"|"QUERY_IN_PROCESS"|"QUERY_FAILURE"|"DELIVERY_IN_PROCESS"|"DELIVERY_SUCCESS"|"DELIVERY_FAILURE"|string;
export type ExecutionStatusReason = "INSUFFICIENT_PERMISSION"|"BILL_OWNER_CHANGED"|"INTERNAL_FAILURE"|string;
export interface Export {
/**
* The data query for this specific data export.
*/
DataQuery: DataQuery;
/**
* The description for this specific data export.
*/
Description?: GenericString;
/**
* The destination configuration for this specific data export.
*/
DestinationConfigurations: DestinationConfigurations;
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn?: Arn;
/**
* The name of this specific data export.
*/
Name: ExportName;
/**
* The cadence for Amazon Web Services to update the export in your S3 bucket.
*/
RefreshCadence: RefreshCadence;
}
export type ExportName = string;
export interface ExportReference {
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn: Arn;
/**
* The name of this specific data export.
*/
ExportName: ExportName;
/**
* The status of this specific data export.
*/
ExportStatus: ExportStatus;
}
export type ExportReferenceList = ExportReference[];
export interface ExportStatus {
/**
* The timestamp of when the export was created.
*/
CreatedAt?: SyntheticTimestamp_date_time;
/**
* The timestamp of when the export was last generated.
*/
LastRefreshedAt?: SyntheticTimestamp_date_time;
/**
* The timestamp of when the export was updated.
*/
LastUpdatedAt?: SyntheticTimestamp_date_time;
/**
* The status code for the request.
*/
StatusCode?: ExportStatusCode;
/**
* The description for the status code.
*/
StatusReason?: ExecutionStatusReason;
}
export type ExportStatusCode = "HEALTHY"|"UNHEALTHY"|string;
export type FormatOption = "TEXT_OR_CSV"|"PARQUET"|string;
export type FrequencyOption = "SYNCHRONOUS"|string;
export type GenericString = string;
export type GenericStringList = GenericString[];
export interface GetExecutionRequest {
/**
* The ID for this specific execution.
*/
ExecutionId: GenericString;
/**
* The Amazon Resource Name (ARN) of the Export object that generated this specific execution.
*/
ExportArn: Arn;
}
export interface GetExecutionResponse {
/**
* The ID for this specific execution.
*/
ExecutionId?: GenericString;
/**
* The status of this specific execution.
*/
ExecutionStatus?: ExecutionStatus;
/**
* The export data for this specific execution. This export data is a snapshot from when the execution was generated. The data could be different from the current export data if the export was updated since the execution was generated.
*/
Export?: Export;
}
export interface GetExportRequest {
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn: Arn;
}
export interface GetExportResponse {
/**
* The data for this specific export.
*/
Export?: Export;
/**
* The status of this specific export.
*/
ExportStatus?: ExportStatus;
}
export interface GetTableRequest {
/**
* The name of the table.
*/
TableName: TableName;
/**
* TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.
*/
TableProperties?: TableProperties;
}
export interface GetTableResponse {
/**
* The table description.
*/
Description?: GenericString;
/**
* The schema of the table.
*/
Schema?: ColumnList;
/**
* The name of the table.
*/
TableName?: TableName;
/**
* TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.
*/
TableProperties?: TableProperties;
}
export interface ListExecutionsRequest {
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn: Arn;
/**
* The maximum number of objects that are returned for the request.
*/
MaxResults?: MaxResults;
/**
* The token to retrieve the next set of results.
*/
NextToken?: NextPageToken;
}
export interface ListExecutionsResponse {
/**
* The list of executions.
*/
Executions?: ExecutionReferenceList;
/**
* The token to retrieve the next set of results.
*/
NextToken?: NextPageToken;
}
export interface ListExportsRequest {
/**
* The maximum number of objects that are returned for the request.
*/
MaxResults?: MaxResults;
/**
* The token to retrieve the next set of results.
*/
NextToken?: NextPageToken;
}
export interface ListExportsResponse {
/**
* The details of the exports, including name and export status.
*/
Exports?: ExportReferenceList;
/**
* The token to retrieve the next set of results.
*/
NextToken?: NextPageToken;
}
export interface ListTablesRequest {
/**
* The maximum number of objects that are returned for the request.
*/
MaxResults?: MaxResults;
/**
* The token to retrieve the next set of results.
*/
NextToken?: NextPageToken;
}
export interface ListTablesResponse {
/**
* The token to retrieve the next set of results.
*/
NextToken?: NextPageToken;
/**
* The list of tables.
*/
Tables?: TableList;
}
export interface ListTagsForResourceRequest {
/**
* The maximum number of objects that are returned for the request.
*/
MaxResults?: MaxResults;
/**
* The token to retrieve the next set of results.
*/
NextToken?: NextPageToken;
/**
* The unique identifier for the resource.
*/
ResourceArn: Arn;
}
export interface ListTagsForResourceResponse {
/**
* The token to retrieve the next set of results.
*/
NextToken?: NextPageToken;
/**
* An optional list of tags to associate with the specified export. Each tag consists of a key and a value, and each key must be unique for the resource.
*/
ResourceTags?: ResourceTagList;
}
export type MaxResults = number;
export type NextPageToken = string;
export type OverwriteOption = "CREATE_NEW_REPORT"|"OVERWRITE_REPORT"|string;
export type QueryStatement = string;
export interface RefreshCadence {
/**
* The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.
*/
Frequency: FrequencyOption;
}
export interface ResourceTag {
/**
* The key that's associated with the tag.
*/
Key: ResourceTagKey;
/**
* The value that's associated with the tag.
*/
Value: ResourceTagValue;
}
export type ResourceTagKey = string;
export type ResourceTagKeyList = ResourceTagKey[];
export type ResourceTagList = ResourceTag[];
export type ResourceTagValue = string;
export interface S3Destination {
/**
* The name of the Amazon S3 bucket used as the destination of a data export file.
*/
S3Bucket: GenericString;
/**
* The output configuration for the data export.
*/
S3OutputConfigurations: S3OutputConfigurations;
/**
* The S3 path prefix you want prepended to the name of your data export.
*/
S3Prefix: GenericString;
/**
* The S3 bucket Region.
*/
S3Region: GenericString;
}
export interface S3OutputConfigurations {
/**
* The compression type for the data export.
*/
Compression: CompressionOption;
/**
* The file format for the data export.
*/
Format: FormatOption;
/**
* The output type for the data export.
*/
OutputType: S3OutputType;
/**
* The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.
*/
Overwrite: OverwriteOption;
}
export type S3OutputType = "CUSTOM"|string;
export type SyntheticTimestamp_date_time = Date;
export interface Table {
/**
* The description for the table.
*/
Description?: GenericString;
/**
* The name of the table.
*/
TableName?: TableName;
/**
* The properties for the table.
*/
TableProperties?: TablePropertyDescriptionList;
}
export type TableConfigurations = {[key: string]: TableProperties};
export type TableList = Table[];
export type TableName = string;
export type TableProperties = {[key: string]: GenericString};
export type TableProperty = string;
export interface TablePropertyDescription {
/**
* The default value for the table.
*/
DefaultValue?: GenericString;
/**
* The description for the table.
*/
Description?: GenericString;
/**
* The name of the table.
*/
Name?: GenericString;
/**
* The valid values for the table.
*/
ValidValues?: GenericStringList;
}
export type TablePropertyDescriptionList = TablePropertyDescription[];
export interface TagResourceRequest {
/**
* The unique identifier for the resource.
*/
ResourceArn: Arn;
/**
* The tags to associate with the resource. Each tag consists of a key and a value, and each key must be unique for the resource.
*/
ResourceTags: ResourceTagList;
}
export interface TagResourceResponse {
}
export interface UntagResourceRequest {
/**
* The unique identifier for the resource.
*/
ResourceArn: Arn;
/**
* The tag keys that are associated with the resource ARN.
*/
ResourceTagKeys: ResourceTagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateExportRequest {
/**
* The name and query details for the export.
*/
Export: Export;
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn: Arn;
}
export interface UpdateExportResponse {
/**
* The Amazon Resource Name (ARN) for this export.
*/
ExportArn?: Arn;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2023-11-26"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the BCMDataExports client.
*/
export import Types = BCMDataExports;
}
export = BCMDataExports;
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['bcmdataexports'] = {};
AWS.BCMDataExports = Service.defineService('bcmdataexports', ['2023-11-26']);
Object.defineProperty(apiLoader.services['bcmdataexports'], '2023-11-26', {
get: function get() {
var model = require('../apis/bcm-data-exports-2023-11-26.min.json');
model.paginators = require('../apis/bcm-data-exports-2023-11-26.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.BCMDataExports;
File diff suppressed because one or more lines are too long
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['bedrock'] = {};
AWS.Bedrock = Service.defineService('bedrock', ['2023-04-20']);
Object.defineProperty(apiLoader.services['bedrock'], '2023-04-20', {
get: function get() {
var model = require('../apis/bedrock-2023-04-20.min.json');
model.paginators = require('../apis/bedrock-2023-04-20.paginators.json').pagination;
model.waiters = require('../apis/bedrock-2023-04-20.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Bedrock;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['bedrockagent'] = {};
AWS.BedrockAgent = Service.defineService('bedrockagent', ['2023-06-05']);
Object.defineProperty(apiLoader.services['bedrockagent'], '2023-06-05', {
get: function get() {
var model = require('../apis/bedrock-agent-2023-06-05.min.json');
model.paginators = require('../apis/bedrock-agent-2023-06-05.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.BedrockAgent;
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['bedrockagentruntime'] = {};
AWS.BedrockAgentRuntime = Service.defineService('bedrockagentruntime', ['2023-07-26']);
Object.defineProperty(apiLoader.services['bedrockagentruntime'], '2023-07-26', {
get: function get() {
var model = require('../apis/bedrock-agent-runtime-2023-07-26.min.json');
model.paginators = require('../apis/bedrock-agent-runtime-2023-07-26.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.BedrockAgentRuntime;
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['bedrockruntime'] = {};
AWS.BedrockRuntime = Service.defineService('bedrockruntime', ['2023-09-30']);
Object.defineProperty(apiLoader.services['bedrockruntime'], '2023-09-30', {
get: function get() {
var model = require('../apis/bedrock-runtime-2023-09-30.min.json');
model.paginators = require('../apis/bedrock-runtime-2023-09-30.paginators.json').pagination;
model.waiters = require('../apis/bedrock-runtime-2023-09-30.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.BedrockRuntime;
File diff suppressed because it is too large Load Diff
+19
View File
@@ -0,0 +1,19 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['billingconductor'] = {};
AWS.Billingconductor = Service.defineService('billingconductor', ['2021-07-30']);
Object.defineProperty(apiLoader.services['billingconductor'], '2021-07-30', {
get: function get() {
var model = require('../apis/billingconductor-2021-07-30.min.json');
model.paginators = require('../apis/billingconductor-2021-07-30.paginators.json').pagination;
model.waiters = require('../apis/billingconductor-2021-07-30.waiters2.json').waiters;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Billingconductor;
+962
View File
@@ -0,0 +1,962 @@
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Braket extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Braket.Types.ClientConfiguration)
config: Config & Braket.Types.ClientConfiguration;
/**
* Cancels an Amazon Braket job.
*/
cancelJob(params: Braket.Types.CancelJobRequest, callback?: (err: AWSError, data: Braket.Types.CancelJobResponse) => void): Request<Braket.Types.CancelJobResponse, AWSError>;
/**
* Cancels an Amazon Braket job.
*/
cancelJob(callback?: (err: AWSError, data: Braket.Types.CancelJobResponse) => void): Request<Braket.Types.CancelJobResponse, AWSError>;
/**
* Cancels the specified task.
*/
cancelQuantumTask(params: Braket.Types.CancelQuantumTaskRequest, callback?: (err: AWSError, data: Braket.Types.CancelQuantumTaskResponse) => void): Request<Braket.Types.CancelQuantumTaskResponse, AWSError>;
/**
* Cancels the specified task.
*/
cancelQuantumTask(callback?: (err: AWSError, data: Braket.Types.CancelQuantumTaskResponse) => void): Request<Braket.Types.CancelQuantumTaskResponse, AWSError>;
/**
* Creates an Amazon Braket job.
*/
createJob(params: Braket.Types.CreateJobRequest, callback?: (err: AWSError, data: Braket.Types.CreateJobResponse) => void): Request<Braket.Types.CreateJobResponse, AWSError>;
/**
* Creates an Amazon Braket job.
*/
createJob(callback?: (err: AWSError, data: Braket.Types.CreateJobResponse) => void): Request<Braket.Types.CreateJobResponse, AWSError>;
/**
* Creates a quantum task.
*/
createQuantumTask(params: Braket.Types.CreateQuantumTaskRequest, callback?: (err: AWSError, data: Braket.Types.CreateQuantumTaskResponse) => void): Request<Braket.Types.CreateQuantumTaskResponse, AWSError>;
/**
* Creates a quantum task.
*/
createQuantumTask(callback?: (err: AWSError, data: Braket.Types.CreateQuantumTaskResponse) => void): Request<Braket.Types.CreateQuantumTaskResponse, AWSError>;
/**
* Retrieves the devices available in Amazon Braket. For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.
*/
getDevice(params: Braket.Types.GetDeviceRequest, callback?: (err: AWSError, data: Braket.Types.GetDeviceResponse) => void): Request<Braket.Types.GetDeviceResponse, AWSError>;
/**
* Retrieves the devices available in Amazon Braket. For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.
*/
getDevice(callback?: (err: AWSError, data: Braket.Types.GetDeviceResponse) => void): Request<Braket.Types.GetDeviceResponse, AWSError>;
/**
* Retrieves the specified Amazon Braket job.
*/
getJob(params: Braket.Types.GetJobRequest, callback?: (err: AWSError, data: Braket.Types.GetJobResponse) => void): Request<Braket.Types.GetJobResponse, AWSError>;
/**
* Retrieves the specified Amazon Braket job.
*/
getJob(callback?: (err: AWSError, data: Braket.Types.GetJobResponse) => void): Request<Braket.Types.GetJobResponse, AWSError>;
/**
* Retrieves the specified quantum task.
*/
getQuantumTask(params: Braket.Types.GetQuantumTaskRequest, callback?: (err: AWSError, data: Braket.Types.GetQuantumTaskResponse) => void): Request<Braket.Types.GetQuantumTaskResponse, AWSError>;
/**
* Retrieves the specified quantum task.
*/
getQuantumTask(callback?: (err: AWSError, data: Braket.Types.GetQuantumTaskResponse) => void): Request<Braket.Types.GetQuantumTaskResponse, AWSError>;
/**
* Shows the tags associated with this resource.
*/
listTagsForResource(params: Braket.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Braket.Types.ListTagsForResourceResponse) => void): Request<Braket.Types.ListTagsForResourceResponse, AWSError>;
/**
* Shows the tags associated with this resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Braket.Types.ListTagsForResourceResponse) => void): Request<Braket.Types.ListTagsForResourceResponse, AWSError>;
/**
* Searches for devices using the specified filters.
*/
searchDevices(params: Braket.Types.SearchDevicesRequest, callback?: (err: AWSError, data: Braket.Types.SearchDevicesResponse) => void): Request<Braket.Types.SearchDevicesResponse, AWSError>;
/**
* Searches for devices using the specified filters.
*/
searchDevices(callback?: (err: AWSError, data: Braket.Types.SearchDevicesResponse) => void): Request<Braket.Types.SearchDevicesResponse, AWSError>;
/**
* Searches for Amazon Braket jobs that match the specified filter values.
*/
searchJobs(params: Braket.Types.SearchJobsRequest, callback?: (err: AWSError, data: Braket.Types.SearchJobsResponse) => void): Request<Braket.Types.SearchJobsResponse, AWSError>;
/**
* Searches for Amazon Braket jobs that match the specified filter values.
*/
searchJobs(callback?: (err: AWSError, data: Braket.Types.SearchJobsResponse) => void): Request<Braket.Types.SearchJobsResponse, AWSError>;
/**
* Searches for tasks that match the specified filter values.
*/
searchQuantumTasks(params: Braket.Types.SearchQuantumTasksRequest, callback?: (err: AWSError, data: Braket.Types.SearchQuantumTasksResponse) => void): Request<Braket.Types.SearchQuantumTasksResponse, AWSError>;
/**
* Searches for tasks that match the specified filter values.
*/
searchQuantumTasks(callback?: (err: AWSError, data: Braket.Types.SearchQuantumTasksResponse) => void): Request<Braket.Types.SearchQuantumTasksResponse, AWSError>;
/**
* Add a tag to the specified resource.
*/
tagResource(params: Braket.Types.TagResourceRequest, callback?: (err: AWSError, data: Braket.Types.TagResourceResponse) => void): Request<Braket.Types.TagResourceResponse, AWSError>;
/**
* Add a tag to the specified resource.
*/
tagResource(callback?: (err: AWSError, data: Braket.Types.TagResourceResponse) => void): Request<Braket.Types.TagResourceResponse, AWSError>;
/**
* Remove tags from a resource.
*/
untagResource(params: Braket.Types.UntagResourceRequest, callback?: (err: AWSError, data: Braket.Types.UntagResourceResponse) => void): Request<Braket.Types.UntagResourceResponse, AWSError>;
/**
* Remove tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: Braket.Types.UntagResourceResponse) => void): Request<Braket.Types.UntagResourceResponse, AWSError>;
}
declare namespace Braket {
export interface AlgorithmSpecification {
/**
* The container image used to create an Amazon Braket job.
*/
containerImage?: ContainerImage;
/**
* Configures the paths to the Python scripts used for entry and training.
*/
scriptModeConfig?: ScriptModeConfig;
}
export interface Association {
/**
* The Amazon Braket resource arn.
*/
arn: BraketResourceArn;
/**
* The association type for the specified Amazon Braket resource arn.
*/
type: AssociationType;
}
export type AssociationType = "RESERVATION_TIME_WINDOW_ARN"|string;
export type Associations = Association[];
export type BraketResourceArn = string;
export interface CancelJobRequest {
/**
* The ARN of the Amazon Braket job to cancel.
*/
jobArn: JobArn;
}
export interface CancelJobResponse {
/**
* The status of the job cancellation request.
*/
cancellationStatus: CancellationStatus;
/**
* The ARN of the Amazon Braket job.
*/
jobArn: JobArn;
}
export interface CancelQuantumTaskRequest {
/**
* The client token associated with the request.
*/
clientToken: String64;
/**
* The ARN of the task to cancel.
*/
quantumTaskArn: QuantumTaskArn;
}
export interface CancelQuantumTaskResponse {
/**
* The status of the cancellation request.
*/
cancellationStatus: CancellationStatus;
/**
* The ARN of the task.
*/
quantumTaskArn: QuantumTaskArn;
}
export type CancellationStatus = "CANCELLING"|"CANCELLED"|string;
export type CompressionType = "NONE"|"GZIP"|string;
export interface ContainerImage {
/**
* The URI locating the container image.
*/
uri: Uri;
}
export interface CreateJobRequest {
/**
* Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.
*/
algorithmSpecification: AlgorithmSpecification;
/**
* The list of Amazon Braket resources associated with the hybrid job.
*/
associations?: CreateJobRequestAssociationsList;
/**
* Information about the output locations for job checkpoint data.
*/
checkpointConfig?: JobCheckpointConfig;
/**
* A unique token that guarantees that the call to this API is idempotent.
*/
clientToken: String64;
/**
* The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
*/
deviceConfig: DeviceConfig;
/**
* Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
*/
hyperParameters?: HyperParameters;
/**
* A list of parameters that specify the name and type of input data and where it is located.
*/
inputDataConfig?: CreateJobRequestInputDataConfigList;
/**
* Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
*/
instanceConfig: InstanceConfig;
/**
* The name of the Amazon Braket job.
*/
jobName: CreateJobRequestJobNameString;
/**
* The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
*/
outputDataConfig: JobOutputDataConfig;
/**
* The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.
*/
roleArn: RoleArn;
/**
* The user-defined criteria that specifies when a job stops running.
*/
stoppingCondition?: JobStoppingCondition;
/**
* A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
*/
tags?: TagsMap;
}
export type CreateJobRequestAssociationsList = Association[];
export type CreateJobRequestInputDataConfigList = InputFileConfig[];
export type CreateJobRequestJobNameString = string;
export interface CreateJobResponse {
/**
* The ARN of the Amazon Braket job created.
*/
jobArn: JobArn;
}
export interface CreateQuantumTaskRequest {
/**
* The action associated with the task.
*/
action: JsonValue;
/**
* The list of Amazon Braket resources associated with the quantum task.
*/
associations?: CreateQuantumTaskRequestAssociationsList;
/**
* The client token associated with the request.
*/
clientToken: String64;
/**
* The ARN of the device to run the task on.
*/
deviceArn: DeviceArn;
/**
* The parameters for the device to run the task on.
*/
deviceParameters?: CreateQuantumTaskRequestDeviceParametersString;
/**
* The token for an Amazon Braket job that associates it with the quantum task.
*/
jobToken?: JobToken;
/**
* The S3 bucket to store task result files in.
*/
outputS3Bucket: CreateQuantumTaskRequestOutputS3BucketString;
/**
* The key prefix for the location in the S3 bucket to store task results in.
*/
outputS3KeyPrefix: CreateQuantumTaskRequestOutputS3KeyPrefixString;
/**
* The number of shots to use for the task.
*/
shots: CreateQuantumTaskRequestShotsLong;
/**
* Tags to be added to the quantum task you're creating.
*/
tags?: TagsMap;
}
export type CreateQuantumTaskRequestAssociationsList = Association[];
export type CreateQuantumTaskRequestDeviceParametersString = string;
export type CreateQuantumTaskRequestOutputS3BucketString = string;
export type CreateQuantumTaskRequestOutputS3KeyPrefixString = string;
export type CreateQuantumTaskRequestShotsLong = number;
export interface CreateQuantumTaskResponse {
/**
* The ARN of the task created by the request.
*/
quantumTaskArn: QuantumTaskArn;
}
export interface DataSource {
/**
* Information about the data stored in Amazon S3 used by the Amazon Braket job.
*/
s3DataSource: S3DataSource;
}
export type DeviceArn = string;
export interface DeviceConfig {
/**
* The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.
*/
device: String256;
}
export interface DeviceQueueInfo {
/**
* The name of the queue.
*/
queue: QueueName;
/**
* Optional. Specifies the priority of the queue. Tasks in a priority queue are processed before the tasks in a normal queue.
*/
queuePriority?: QueuePriority;
/**
* The number of jobs or tasks in the queue for a given device.
*/
queueSize: String;
}
export type DeviceQueueInfoList = DeviceQueueInfo[];
export type DeviceStatus = "ONLINE"|"OFFLINE"|"RETIRED"|string;
export interface DeviceSummary {
/**
* The ARN of the device.
*/
deviceArn: DeviceArn;
/**
* The name of the device.
*/
deviceName: String;
/**
* The status of the device.
*/
deviceStatus: DeviceStatus;
/**
* The type of the device.
*/
deviceType: DeviceType;
/**
* The provider of the device.
*/
providerName: String;
}
export type DeviceSummaryList = DeviceSummary[];
export type DeviceType = "QPU"|"SIMULATOR"|string;
export interface GetDeviceRequest {
/**
* The ARN of the device to retrieve.
*/
deviceArn: DeviceArn;
}
export interface GetDeviceResponse {
/**
* The ARN of the device.
*/
deviceArn: DeviceArn;
/**
* Details about the capabilities of the device.
*/
deviceCapabilities: JsonValue;
/**
* The name of the device.
*/
deviceName: String;
/**
* List of information about tasks and jobs queued on a device.
*/
deviceQueueInfo?: DeviceQueueInfoList;
/**
* The status of the device.
*/
deviceStatus: DeviceStatus;
/**
* The type of the device.
*/
deviceType: DeviceType;
/**
* The name of the partner company for the device.
*/
providerName: String;
}
export interface GetJobRequest {
/**
* A list of attributes to return information for.
*/
additionalAttributeNames?: HybridJobAdditionalAttributeNamesList;
/**
* The ARN of the job to retrieve.
*/
jobArn: JobArn;
}
export interface GetJobResponse {
/**
* Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
*/
algorithmSpecification: AlgorithmSpecification;
/**
* The list of Amazon Braket resources associated with the hybrid job.
*/
associations?: Associations;
/**
* The billable time the Amazon Braket job used to complete.
*/
billableDuration?: Integer;
/**
* Information about the output locations for job checkpoint data.
*/
checkpointConfig?: JobCheckpointConfig;
/**
* The date and time that the Amazon Braket job was created.
*/
createdAt: SyntheticTimestamp_date_time;
/**
* The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
*/
deviceConfig?: DeviceConfig;
/**
* The date and time that the Amazon Braket job ended.
*/
endedAt?: SyntheticTimestamp_date_time;
/**
* Details about the type and time events occurred related to the Amazon Braket job.
*/
events?: JobEvents;
/**
* A description of the reason why an Amazon Braket job failed, if it failed.
*/
failureReason?: String1024;
/**
* Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
*/
hyperParameters?: HyperParameters;
/**
* A list of parameters that specify the name and type of input data and where it is located.
*/
inputDataConfig?: InputConfigList;
/**
* The resource instances to use while running the hybrid job on Amazon Braket.
*/
instanceConfig: InstanceConfig;
/**
* The ARN of the Amazon Braket job.
*/
jobArn: JobArn;
/**
* The name of the Amazon Braket job.
*/
jobName: GetJobResponseJobNameString;
/**
* The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
*/
outputDataConfig: JobOutputDataConfig;
/**
* Queue information for the requested job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.
*/
queueInfo?: HybridJobQueueInfo;
/**
* The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.
*/
roleArn: RoleArn;
/**
* The date and time that the Amazon Braket job was started.
*/
startedAt?: SyntheticTimestamp_date_time;
/**
* The status of the Amazon Braket job.
*/
status: JobPrimaryStatus;
/**
* The user-defined criteria that specifies when to stop a job running.
*/
stoppingCondition?: JobStoppingCondition;
/**
* A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
*/
tags?: TagsMap;
}
export type GetJobResponseJobNameString = string;
export interface GetQuantumTaskRequest {
/**
* A list of attributes to return information for.
*/
additionalAttributeNames?: QuantumTaskAdditionalAttributeNamesList;
/**
* The ARN of the task to retrieve.
*/
quantumTaskArn: QuantumTaskArn;
}
export interface GetQuantumTaskResponse {
/**
* The list of Amazon Braket resources associated with the quantum task.
*/
associations?: Associations;
/**
* The time at which the task was created.
*/
createdAt: SyntheticTimestamp_date_time;
/**
* The ARN of the device the task was run on.
*/
deviceArn: DeviceArn;
/**
* The parameters for the device on which the task ran.
*/
deviceParameters: JsonValue;
/**
* The time at which the task ended.
*/
endedAt?: SyntheticTimestamp_date_time;
/**
* The reason that a task failed.
*/
failureReason?: String;
/**
* The ARN of the Amazon Braket job associated with the quantum task.
*/
jobArn?: JobArn;
/**
* The S3 bucket where task results are stored.
*/
outputS3Bucket: String;
/**
* The folder in the S3 bucket where task results are stored.
*/
outputS3Directory: String;
/**
* The ARN of the task.
*/
quantumTaskArn: QuantumTaskArn;
/**
* Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetQuantumTask API request.
*/
queueInfo?: QuantumTaskQueueInfo;
/**
* The number of shots used in the task.
*/
shots: Long;
/**
* The status of the task.
*/
status: QuantumTaskStatus;
/**
* The tags that belong to this task.
*/
tags?: TagsMap;
}
export type HybridJobAdditionalAttributeName = "QueueInfo"|string;
export type HybridJobAdditionalAttributeNamesList = HybridJobAdditionalAttributeName[];
export interface HybridJobQueueInfo {
/**
* Optional. Provides more information about the queue position. For example, if the job is complete and no longer in the queue, the message field contains that information.
*/
message?: String;
/**
* Current position of the job in the jobs queue.
*/
position: String;
/**
* The name of the queue.
*/
queue: QueueName;
}
export type HyperParameters = {[key: string]: HyperParametersValueString};
export type HyperParametersValueString = string;
export type InputConfigList = InputFileConfig[];
export interface InputFileConfig {
/**
* A named input source that an Amazon Braket job can consume.
*/
channelName: InputFileConfigChannelNameString;
/**
* The MIME type of the data.
*/
contentType?: String256;
/**
* The location of the channel data.
*/
dataSource: DataSource;
}
export type InputFileConfigChannelNameString = string;
export interface InstanceConfig {
/**
* Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1.
*/
instanceCount?: InstanceConfigInstanceCountInteger;
/**
* Configures the type resource instances to use while running an Amazon Braket hybrid job.
*/
instanceType: InstanceType;
/**
* The size of the storage volume, in GB, that user wants to provision.
*/
volumeSizeInGb: InstanceConfigVolumeSizeInGbInteger;
}
export type InstanceConfigInstanceCountInteger = number;
export type InstanceConfigVolumeSizeInGbInteger = number;
export type InstanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge"|"ml.p4d.24xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5n.xlarge"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|string;
export type Integer = number;
export type JobArn = string;
export interface JobCheckpointConfig {
/**
* (Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.
*/
localPath?: String4096;
/**
* Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.
*/
s3Uri: S3Path;
}
export interface JobEventDetails {
/**
* The type of event that occurred related to the Amazon Braket job.
*/
eventType?: JobEventType;
/**
* A message describing the event that occurred related to the Amazon Braket job.
*/
message?: JobEventDetailsMessageString;
/**
* The type of event that occurred related to the Amazon Braket job.
*/
timeOfEvent?: SyntheticTimestamp_date_time;
}
export type JobEventDetailsMessageString = string;
export type JobEventType = "WAITING_FOR_PRIORITY"|"QUEUED_FOR_EXECUTION"|"STARTING_INSTANCE"|"DOWNLOADING_DATA"|"RUNNING"|"DEPRIORITIZED_DUE_TO_INACTIVITY"|"UPLOADING_RESULTS"|"COMPLETED"|"FAILED"|"MAX_RUNTIME_EXCEEDED"|"CANCELLED"|string;
export type JobEvents = JobEventDetails[];
export interface JobOutputDataConfig {
/**
* The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job training artifacts at rest using Amazon S3 server-side encryption.
*/
kmsKeyId?: String2048;
/**
* Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example, s3://bucket-name/key-name-prefix.
*/
s3Path: S3Path;
}
export type JobPrimaryStatus = "QUEUED"|"RUNNING"|"COMPLETED"|"FAILED"|"CANCELLING"|"CANCELLED"|string;
export interface JobStoppingCondition {
/**
* The maximum length of time, in seconds, that an Amazon Braket job can run.
*/
maxRuntimeInSeconds?: JobStoppingConditionMaxRuntimeInSecondsInteger;
}
export type JobStoppingConditionMaxRuntimeInSecondsInteger = number;
export interface JobSummary {
/**
* The date and time that the Amazon Braket job was created.
*/
createdAt: SyntheticTimestamp_date_time;
/**
* Provides summary information about the primary device used by an Amazon Braket job.
*/
device: String256;
/**
* The date and time that the Amazon Braket job ended.
*/
endedAt?: SyntheticTimestamp_date_time;
/**
* The ARN of the Amazon Braket job.
*/
jobArn: JobArn;
/**
* The name of the Amazon Braket job.
*/
jobName: String;
/**
* The date and time that the Amazon Braket job was started.
*/
startedAt?: SyntheticTimestamp_date_time;
/**
* The status of the Amazon Braket job.
*/
status: JobPrimaryStatus;
/**
* A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
*/
tags?: TagsMap;
}
export type JobSummaryList = JobSummary[];
export type JobToken = string;
export type JsonValue = string;
export interface ListTagsForResourceRequest {
/**
* Specify the resourceArn for the resource whose tags to display.
*/
resourceArn: String;
}
export interface ListTagsForResourceResponse {
/**
* Displays the key, value pairs of tags associated with this resource.
*/
tags?: TagsMap;
}
export type Long = number;
export type QuantumTaskAdditionalAttributeName = "QueueInfo"|string;
export type QuantumTaskAdditionalAttributeNamesList = QuantumTaskAdditionalAttributeName[];
export type QuantumTaskArn = string;
export interface QuantumTaskQueueInfo {
/**
* Optional. Provides more information about the queue position. For example, if the task is complete and no longer in the queue, the message field contains that information.
*/
message?: String;
/**
* Current position of the task in the quantum tasks queue.
*/
position: String;
/**
* The name of the queue.
*/
queue: QueueName;
/**
* Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the tasks in a normal queue.
*/
queuePriority?: QueuePriority;
}
export type QuantumTaskStatus = "CREATED"|"QUEUED"|"RUNNING"|"COMPLETED"|"FAILED"|"CANCELLING"|"CANCELLED"|string;
export interface QuantumTaskSummary {
/**
* The time at which the task was created.
*/
createdAt: SyntheticTimestamp_date_time;
/**
* The ARN of the device the task ran on.
*/
deviceArn: DeviceArn;
/**
* The time at which the task finished.
*/
endedAt?: SyntheticTimestamp_date_time;
/**
* The S3 bucket where the task result file is stored..
*/
outputS3Bucket: String;
/**
* The folder in the S3 bucket where the task result file is stored.
*/
outputS3Directory: String;
/**
* The ARN of the task.
*/
quantumTaskArn: QuantumTaskArn;
/**
* The shots used for the task.
*/
shots: Long;
/**
* The status of the task.
*/
status: QuantumTaskStatus;
/**
* Displays the key, value pairs of tags associated with this quantum task.
*/
tags?: TagsMap;
}
export type QuantumTaskSummaryList = QuantumTaskSummary[];
export type QueueName = "QUANTUM_TASKS_QUEUE"|"JOBS_QUEUE"|string;
export type QueuePriority = "Normal"|"Priority"|string;
export type RoleArn = string;
export interface S3DataSource {
/**
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.
*/
s3Uri: S3Path;
}
export type S3Path = string;
export interface ScriptModeConfig {
/**
* The type of compression used by the Python scripts for an Amazon Braket job.
*/
compressionType?: CompressionType;
/**
* The path to the Python script that serves as the entry point for an Amazon Braket job.
*/
entryPoint: String;
/**
* The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job.
*/
s3Uri: S3Path;
}
export interface SearchDevicesFilter {
/**
* The name to use to filter results.
*/
name: SearchDevicesFilterNameString;
/**
* The values to use to filter results.
*/
values: SearchDevicesFilterValuesList;
}
export type SearchDevicesFilterNameString = string;
export type SearchDevicesFilterValuesList = String256[];
export interface SearchDevicesRequest {
/**
* The filter values to use to search for a device.
*/
filters: SearchDevicesRequestFiltersList;
/**
* The maximum number of results to return in the response.
*/
maxResults?: SearchDevicesRequestMaxResultsInteger;
/**
* A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.
*/
nextToken?: String;
}
export type SearchDevicesRequestFiltersList = SearchDevicesFilter[];
export type SearchDevicesRequestMaxResultsInteger = number;
export interface SearchDevicesResponse {
/**
* An array of DeviceSummary objects for devices that match the specified filter values.
*/
devices: DeviceSummaryList;
/**
* A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.
*/
nextToken?: String;
}
export interface SearchJobsFilter {
/**
* The name to use for the jobs filter.
*/
name: String64;
/**
* An operator to use for the jobs filter.
*/
operator: SearchJobsFilterOperator;
/**
* The values to use for the jobs filter.
*/
values: SearchJobsFilterValuesList;
}
export type SearchJobsFilterOperator = "LT"|"LTE"|"EQUAL"|"GT"|"GTE"|"BETWEEN"|"CONTAINS"|string;
export type SearchJobsFilterValuesList = String256[];
export interface SearchJobsRequest {
/**
* The filter values to use when searching for a job.
*/
filters: SearchJobsRequestFiltersList;
/**
* The maximum number of results to return in the response.
*/
maxResults?: SearchJobsRequestMaxResultsInteger;
/**
* A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.
*/
nextToken?: String;
}
export type SearchJobsRequestFiltersList = SearchJobsFilter[];
export type SearchJobsRequestMaxResultsInteger = number;
export interface SearchJobsResponse {
/**
* An array of JobSummary objects for devices that match the specified filter values.
*/
jobs: JobSummaryList;
/**
* A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.
*/
nextToken?: String;
}
export interface SearchQuantumTasksFilter {
/**
* The name of the device used for the task.
*/
name: String64;
/**
* An operator to use in the filter.
*/
operator: SearchQuantumTasksFilterOperator;
/**
* The values to use for the filter.
*/
values: SearchQuantumTasksFilterValuesList;
}
export type SearchQuantumTasksFilterOperator = "LT"|"LTE"|"EQUAL"|"GT"|"GTE"|"BETWEEN"|string;
export type SearchQuantumTasksFilterValuesList = String256[];
export interface SearchQuantumTasksRequest {
/**
* Array of SearchQuantumTasksFilter objects.
*/
filters: SearchQuantumTasksRequestFiltersList;
/**
* Maximum number of results to return in the response.
*/
maxResults?: SearchQuantumTasksRequestMaxResultsInteger;
/**
* A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.
*/
nextToken?: String;
}
export type SearchQuantumTasksRequestFiltersList = SearchQuantumTasksFilter[];
export type SearchQuantumTasksRequestMaxResultsInteger = number;
export interface SearchQuantumTasksResponse {
/**
* A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.
*/
nextToken?: String;
/**
* An array of QuantumTaskSummary objects for tasks that match the specified filters.
*/
quantumTasks: QuantumTaskSummaryList;
}
export type String = string;
export type String1024 = string;
export type String2048 = string;
export type String256 = string;
export type String4096 = string;
export type String64 = string;
export type SyntheticTimestamp_date_time = Date;
export type TagKeys = String[];
export interface TagResourceRequest {
/**
* Specify the resourceArn of the resource to which a tag will be added.
*/
resourceArn: String;
/**
* Specify the tags to add to the resource.
*/
tags: TagsMap;
}
export interface TagResourceResponse {
}
export type TagsMap = {[key: string]: String};
export interface UntagResourceRequest {
/**
* Specify the resourceArn for the resource from which to remove the tags.
*/
resourceArn: String;
/**
* Specify the keys for the tags to remove from the resource.
*/
tagKeys: TagKeys;
}
export interface UntagResourceResponse {
}
export type Uri = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-09-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Braket client.
*/
export import Types = Braket;
}
export = Braket;
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['braket'] = {};
AWS.Braket = Service.defineService('braket', ['2019-09-01']);
Object.defineProperty(apiLoader.services['braket'], '2019-09-01', {
get: function get() {
var model = require('../apis/braket-2019-09-01.min.json');
model.paginators = require('../apis/braket-2019-09-01.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Braket;
+92
View File
@@ -0,0 +1,92 @@
export import ACM = require('./acm');
export import APIGateway = require('./apigateway');
export import ApplicationAutoScaling = require('./applicationautoscaling');
export import AutoScaling = require('./autoscaling');
export import CloudFormation = require('./cloudformation');
export import CloudFront = require('./cloudfront');
export import CloudHSM = require('./cloudhsm');
export import CloudTrail = require('./cloudtrail');
export import CloudWatch = require('./cloudwatch');
export import CloudWatchEvents = require('./cloudwatchevents');
export import CloudWatchLogs = require('./cloudwatchlogs');
export import CodeBuild = require('./codebuild');
export import CodeCommit = require('./codecommit');
export import CodeDeploy = require('./codedeploy');
export import CodePipeline = require('./codepipeline');
export import CognitoIdentity = require('./cognitoidentity');
export import CognitoIdentityServiceProvider = require('./cognitoidentityserviceprovider');
export import CognitoSync = require('./cognitosync');
export import ConfigService = require('./configservice');
export import CUR = require('./cur');
export import DeviceFarm = require('./devicefarm');
export import DirectConnect = require('./directconnect');
export import DynamoDB = require('./dynamodb');
export import DynamoDBStreams = require('./dynamodbstreams');
export import EC2 = require('./ec2');
export import ECR = require('./ecr');
export import ECS = require('./ecs');
export import EFS = require('./efs');
export import ElastiCache = require('./elasticache');
export import ElasticBeanstalk = require('./elasticbeanstalk');
export import ELB = require('./elb');
export import ELBv2 = require('./elbv2');
export import EMR = require('./emr');
export import ElasticTranscoder = require('./elastictranscoder');
export import Firehose = require('./firehose');
export import GameLift = require('./gamelift');
export import IAM = require('./iam');
export import Inspector = require('./inspector');
export import Iot = require('./iot');
export import IotData = require('./iotdata');
export import Kinesis = require('./kinesis');
export import KMS = require('./kms');
export import Lambda = require('./lambda');
export import LexRuntime = require('./lexruntime');
export import MachineLearning = require('./machinelearning');
export import MarketplaceCommerceAnalytics = require('./marketplacecommerceanalytics');
export import MTurk = require('./mturk');
export import MobileAnalytics = require('./mobileanalytics');
export import OpsWorks = require('./opsworks');
export import Polly = require('./polly');
export import RDS = require('./rds');
export import Redshift = require('./redshift');
export import Rekognition = require('./rekognition');
export import Route53 = require('./route53');
export import Route53Domains = require('./route53domains');
export import S3 = require('./s3');
export import ServiceCatalog = require('./servicecatalog');
export import SES = require('./ses');
export import SNS = require('./sns');
export import SQS = require('./sqs');
export import SSM = require('./ssm');
export import StorageGateway = require('./storagegateway');
export import STS = require('./sts');
export import XRay = require('./xray');
export import WAF = require('./waf');
export import WorkDocs = require('./workdocs');
export import LexModelBuildingService = require('./lexmodelbuildingservice');
export import Athena = require('./athena');
export import CloudHSMV2 = require('./cloudhsmv2');
export import Pricing = require('./pricing');
export import CostExplorer = require('./costexplorer');
export import MediaStoreData = require('./mediastoredata');
export import Comprehend = require('./comprehend');
export import KinesisVideoArchivedMedia = require('./kinesisvideoarchivedmedia');
export import KinesisVideoMedia = require('./kinesisvideomedia');
export import KinesisVideo = require('./kinesisvideo');
export import Translate = require('./translate');
export import ResourceGroups = require('./resourcegroups');
export import Connect = require('./connect');
export import SecretsManager = require('./secretsmanager');
export import IoTAnalytics = require('./iotanalytics');
export import ComprehendMedical = require('./comprehendmedical');
export import Personalize = require('./personalize');
export import PersonalizeEvents = require('./personalizeevents');
export import PersonalizeRuntime = require('./personalizeruntime');
export import ForecastService = require('./forecastservice');
export import ForecastQueryService = require('./forecastqueryservice');
export import MarketplaceCatalog = require('./marketplacecatalog');
export import KinesisVideoSignalingChannels = require('./kinesisvideosignalingchannels');
export import Amp = require('./amp');
export import Location = require('./location');
export import LexRuntimeV2 = require('./lexruntimev2');
+95
View File
@@ -0,0 +1,95 @@
require('../lib/node_loader');
module.exports = {
ACM: require('./acm'),
APIGateway: require('./apigateway'),
ApplicationAutoScaling: require('./applicationautoscaling'),
AutoScaling: require('./autoscaling'),
CloudFormation: require('./cloudformation'),
CloudFront: require('./cloudfront'),
CloudHSM: require('./cloudhsm'),
CloudTrail: require('./cloudtrail'),
CloudWatch: require('./cloudwatch'),
CloudWatchEvents: require('./cloudwatchevents'),
CloudWatchLogs: require('./cloudwatchlogs'),
CodeBuild: require('./codebuild'),
CodeCommit: require('./codecommit'),
CodeDeploy: require('./codedeploy'),
CodePipeline: require('./codepipeline'),
CognitoIdentity: require('./cognitoidentity'),
CognitoIdentityServiceProvider: require('./cognitoidentityserviceprovider'),
CognitoSync: require('./cognitosync'),
ConfigService: require('./configservice'),
CUR: require('./cur'),
DeviceFarm: require('./devicefarm'),
DirectConnect: require('./directconnect'),
DynamoDB: require('./dynamodb'),
DynamoDBStreams: require('./dynamodbstreams'),
EC2: require('./ec2'),
ECR: require('./ecr'),
ECS: require('./ecs'),
EFS: require('./efs'),
ElastiCache: require('./elasticache'),
ElasticBeanstalk: require('./elasticbeanstalk'),
ELB: require('./elb'),
ELBv2: require('./elbv2'),
EMR: require('./emr'),
ElasticTranscoder: require('./elastictranscoder'),
Firehose: require('./firehose'),
GameLift: require('./gamelift'),
IAM: require('./iam'),
Inspector: require('./inspector'),
Iot: require('./iot'),
IotData: require('./iotdata'),
Kinesis: require('./kinesis'),
KMS: require('./kms'),
Lambda: require('./lambda'),
LexRuntime: require('./lexruntime'),
MachineLearning: require('./machinelearning'),
MarketplaceCommerceAnalytics: require('./marketplacecommerceanalytics'),
MTurk: require('./mturk'),
MobileAnalytics: require('./mobileanalytics'),
OpsWorks: require('./opsworks'),
Polly: require('./polly'),
RDS: require('./rds'),
Redshift: require('./redshift'),
Rekognition: require('./rekognition'),
Route53: require('./route53'),
Route53Domains: require('./route53domains'),
S3: require('./s3'),
ServiceCatalog: require('./servicecatalog'),
SES: require('./ses'),
SNS: require('./sns'),
SQS: require('./sqs'),
SSM: require('./ssm'),
StorageGateway: require('./storagegateway'),
STS: require('./sts'),
XRay: require('./xray'),
WAF: require('./waf'),
WorkDocs: require('./workdocs'),
LexModelBuildingService: require('./lexmodelbuildingservice'),
Athena: require('./athena'),
CloudHSMV2: require('./cloudhsmv2'),
Pricing: require('./pricing'),
CostExplorer: require('./costexplorer'),
MediaStoreData: require('./mediastoredata'),
Comprehend: require('./comprehend'),
KinesisVideoArchivedMedia: require('./kinesisvideoarchivedmedia'),
KinesisVideoMedia: require('./kinesisvideomedia'),
KinesisVideo: require('./kinesisvideo'),
Translate: require('./translate'),
ResourceGroups: require('./resourcegroups'),
Connect: require('./connect'),
SecretsManager: require('./secretsmanager'),
IoTAnalytics: require('./iotanalytics'),
ComprehendMedical: require('./comprehendmedical'),
Personalize: require('./personalize'),
PersonalizeEvents: require('./personalizeevents'),
PersonalizeRuntime: require('./personalizeruntime'),
ForecastService: require('./forecastservice'),
ForecastQueryService: require('./forecastqueryservice'),
MarketplaceCatalog: require('./marketplacecatalog'),
KinesisVideoSignalingChannels: require('./kinesisvideosignalingchannels'),
Amp: require('./amp'),
Location: require('./location'),
LexRuntimeV2: require('./lexruntimev2')
};
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['budgets'] = {};
AWS.Budgets = Service.defineService('budgets', ['2016-10-20']);
Object.defineProperty(apiLoader.services['budgets'], '2016-10-20', {
get: function get() {
var model = require('../apis/budgets-2016-10-20.min.json');
model.paginators = require('../apis/budgets-2016-10-20.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Budgets;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['chatbot'] = {};
AWS.Chatbot = Service.defineService('chatbot', ['2017-10-11']);
Object.defineProperty(apiLoader.services['chatbot'], '2017-10-11', {
get: function get() {
var model = require('../apis/chatbot-2017-10-11.min.json');
model.paginators = require('../apis/chatbot-2017-10-11.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Chatbot;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['chime'] = {};
AWS.Chime = Service.defineService('chime', ['2018-05-01']);
Object.defineProperty(apiLoader.services['chime'], '2018-05-01', {
get: function get() {
var model = require('../apis/chime-2018-05-01.min.json');
model.paginators = require('../apis/chime-2018-05-01.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.Chime;
File diff suppressed because it is too large Load Diff
+18
View File
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['chimesdkidentity'] = {};
AWS.ChimeSDKIdentity = Service.defineService('chimesdkidentity', ['2021-04-20']);
Object.defineProperty(apiLoader.services['chimesdkidentity'], '2021-04-20', {
get: function get() {
var model = require('../apis/chime-sdk-identity-2021-04-20.min.json');
model.paginators = require('../apis/chime-sdk-identity-2021-04-20.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ChimeSDKIdentity;
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,18 @@
require('../lib/node_loader');
var AWS = require('../lib/core');
var Service = AWS.Service;
var apiLoader = AWS.apiLoader;
apiLoader.services['chimesdkmediapipelines'] = {};
AWS.ChimeSDKMediaPipelines = Service.defineService('chimesdkmediapipelines', ['2021-07-15']);
Object.defineProperty(apiLoader.services['chimesdkmediapipelines'], '2021-07-15', {
get: function get() {
var model = require('../apis/chime-sdk-media-pipelines-2021-07-15.min.json');
model.paginators = require('../apis/chime-sdk-media-pipelines-2021-07-15.paginators.json').pagination;
return model;
},
enumerable: true,
configurable: true
});
module.exports = AWS.ChimeSDKMediaPipelines;

Some files were not shown because too many files have changed in this diff Show More