import type AWS from "aws-sdk"; import type { SdkCallOptions } from "./types"; export interface SDK { readonly ACM: ACM; readonly ACMPCA: ACMPCA; readonly APIGateway: APIGateway; readonly AccessAnalyzer: AccessAnalyzer; readonly Account: Account; readonly AlexaForBusiness: AlexaForBusiness; readonly Amp: Amp; readonly Amplify: Amplify; readonly AmplifyBackend: AmplifyBackend; readonly AmplifyUIBuilder: AmplifyUIBuilder; readonly ApiGatewayManagementApi: ApiGatewayManagementApi; readonly ApiGatewayV2: ApiGatewayV2; readonly AppConfig: AppConfig; readonly AppConfigData: AppConfigData; readonly AppIntegrations: AppIntegrations; readonly AppMesh: AppMesh; readonly AppRunner: AppRunner; readonly AppStream: AppStream; readonly AppSync: AppSync; readonly Appflow: Appflow; readonly ApplicationAutoScaling: ApplicationAutoScaling; readonly ApplicationCostProfiler: ApplicationCostProfiler; readonly ApplicationInsights: ApplicationInsights; readonly Athena: Athena; readonly AuditManager: AuditManager; readonly AugmentedAIRuntime: AugmentedAIRuntime; readonly AutoScaling: AutoScaling; readonly AutoScalingPlans: AutoScalingPlans; readonly Backup: Backup; readonly BackupGateway: BackupGateway; readonly BackupStorage: BackupStorage; readonly Batch: Batch; readonly Billingconductor: Billingconductor; readonly Braket: Braket; readonly Budgets: Budgets; readonly CUR: CUR; readonly Chime: Chime; readonly ChimeSDKIdentity: ChimeSDKIdentity; readonly ChimeSDKMediaPipelines: ChimeSDKMediaPipelines; readonly ChimeSDKMeetings: ChimeSDKMeetings; readonly ChimeSDKMessaging: ChimeSDKMessaging; readonly Cloud9: Cloud9; readonly CloudControl: CloudControl; readonly CloudDirectory: CloudDirectory; readonly CloudFormation: CloudFormation; readonly CloudFront: CloudFront; readonly CloudHSM: CloudHSM; readonly CloudHSMV2: CloudHSMV2; readonly CloudSearch: CloudSearch; readonly CloudSearchDomain: CloudSearchDomain; readonly CloudTrail: CloudTrail; readonly CloudWatch: CloudWatch; readonly CloudWatchEvents: CloudWatchEvents; readonly CloudWatchLogs: CloudWatchLogs; readonly CodeArtifact: CodeArtifact; readonly CodeBuild: CodeBuild; readonly CodeCommit: CodeCommit; readonly CodeDeploy: CodeDeploy; readonly CodeGuruProfiler: CodeGuruProfiler; readonly CodeGuruReviewer: CodeGuruReviewer; readonly CodePipeline: CodePipeline; readonly CodeStar: CodeStar; readonly CodeStarNotifications: CodeStarNotifications; readonly CodeStarconnections: CodeStarconnections; readonly CognitoIdentity: CognitoIdentity; readonly CognitoIdentityServiceProvider: CognitoIdentityServiceProvider; readonly CognitoSync: CognitoSync; readonly Comprehend: Comprehend; readonly ComprehendMedical: ComprehendMedical; readonly ComputeOptimizer: ComputeOptimizer; readonly ConfigService: ConfigService; readonly Connect: Connect; readonly ConnectCampaigns: ConnectCampaigns; readonly ConnectCases: ConnectCases; readonly ConnectContactLens: ConnectContactLens; readonly ConnectParticipant: ConnectParticipant; readonly ControlTower: ControlTower; readonly CostExplorer: CostExplorer; readonly CustomerProfiles: CustomerProfiles; readonly DAX: DAX; readonly DLM: DLM; readonly DMS: DMS; readonly DataBrew: DataBrew; readonly DataExchange: DataExchange; readonly DataPipeline: DataPipeline; readonly DataSync: DataSync; readonly Detective: Detective; readonly DevOpsGuru: DevOpsGuru; readonly DeviceFarm: DeviceFarm; readonly DirectConnect: DirectConnect; readonly DirectoryService: DirectoryService; readonly Discovery: Discovery; readonly DocDB: DocDB; readonly Drs: Drs; readonly DynamoDB: DynamoDB; readonly DynamoDBStreams: DynamoDBStreams; readonly EBS: EBS; readonly EC2: EC2; readonly EC2InstanceConnect: EC2InstanceConnect; readonly ECR: ECR; readonly ECRPUBLIC: ECRPUBLIC; readonly ECS: ECS; readonly EFS: EFS; readonly EKS: EKS; readonly ELB: ELB; readonly ELBv2: ELBv2; readonly EMR: EMR; readonly EMRServerless: EMRServerless; readonly EMRcontainers: EMRcontainers; readonly ES: ES; readonly ElastiCache: ElastiCache; readonly ElasticBeanstalk: ElasticBeanstalk; readonly ElasticInference: ElasticInference; readonly ElasticTranscoder: ElasticTranscoder; readonly EventBridge: EventBridge; readonly Evidently: Evidently; readonly FMS: FMS; readonly FSx: FSx; readonly Finspace: Finspace; readonly Finspacedata: Finspacedata; readonly Firehose: Firehose; readonly Fis: Fis; readonly ForecastQueryService: ForecastQueryService; readonly ForecastService: ForecastService; readonly FraudDetector: FraudDetector; readonly GameLift: GameLift; readonly GameSparks: GameSparks; readonly Glacier: Glacier; readonly GlobalAccelerator: GlobalAccelerator; readonly Glue: Glue; readonly Grafana: Grafana; readonly Greengrass: Greengrass; readonly GreengrassV2: GreengrassV2; readonly GroundStation: GroundStation; readonly GuardDuty: GuardDuty; readonly Health: Health; readonly HealthLake: HealthLake; readonly Honeycode: Honeycode; readonly IAM: IAM; readonly IVS: IVS; readonly IdentityStore: IdentityStore; readonly Imagebuilder: Imagebuilder; readonly ImportExport: ImportExport; readonly Inspector: Inspector; readonly Inspector2: Inspector2; readonly IoT1ClickDevicesService: IoT1ClickDevicesService; readonly IoT1ClickProjects: IoT1ClickProjects; readonly IoTAnalytics: IoTAnalytics; readonly IoTEvents: IoTEvents; readonly IoTEventsData: IoTEventsData; readonly IoTFleetHub: IoTFleetHub; readonly IoTFleetWise: IoTFleetWise; readonly IoTJobsDataPlane: IoTJobsDataPlane; readonly IoTSecureTunneling: IoTSecureTunneling; readonly IoTSiteWise: IoTSiteWise; readonly IoTThingsGraph: IoTThingsGraph; readonly IoTTwinMaker: IoTTwinMaker; readonly IoTWireless: IoTWireless; readonly Iot: Iot; readonly IotData: IotData; readonly IotDeviceAdvisor: IotDeviceAdvisor; readonly Ivschat: Ivschat; readonly KMS: KMS; readonly Kafka: Kafka; readonly KafkaConnect: KafkaConnect; readonly Kendra: Kendra; readonly Keyspaces: Keyspaces; readonly Kinesis: Kinesis; readonly KinesisAnalytics: KinesisAnalytics; readonly KinesisAnalyticsV2: KinesisAnalyticsV2; readonly KinesisVideo: KinesisVideo; readonly KinesisVideoArchivedMedia: KinesisVideoArchivedMedia; readonly KinesisVideoMedia: KinesisVideoMedia; readonly KinesisVideoSignalingChannels: KinesisVideoSignalingChannels; readonly LakeFormation: LakeFormation; readonly Lambda: Lambda; readonly LexModelBuildingService: LexModelBuildingService; readonly LexModelsV2: LexModelsV2; readonly LexRuntime: LexRuntime; readonly LexRuntimeV2: LexRuntimeV2; readonly LicenseManager: LicenseManager; readonly LicenseManagerUserSubscriptions: LicenseManagerUserSubscriptions; readonly Lightsail: Lightsail; readonly Location: Location; readonly LookoutEquipment: LookoutEquipment; readonly LookoutMetrics: LookoutMetrics; readonly LookoutVision: LookoutVision; readonly M2: M2; readonly MQ: MQ; readonly MTurk: MTurk; readonly MWAA: MWAA; readonly MachineLearning: MachineLearning; readonly Macie: Macie; readonly Macie2: Macie2; readonly ManagedBlockchain: ManagedBlockchain; readonly MarketplaceCatalog: MarketplaceCatalog; readonly MarketplaceCommerceAnalytics: MarketplaceCommerceAnalytics; readonly MarketplaceEntitlementService: MarketplaceEntitlementService; readonly MarketplaceMetering: MarketplaceMetering; readonly MediaConnect: MediaConnect; readonly MediaConvert: MediaConvert; readonly MediaLive: MediaLive; readonly MediaPackage: MediaPackage; readonly MediaPackageVod: MediaPackageVod; readonly MediaStore: MediaStore; readonly MediaStoreData: MediaStoreData; readonly MediaTailor: MediaTailor; readonly MemoryDB: MemoryDB; readonly Mgn: Mgn; readonly MigrationHub: MigrationHub; readonly MigrationHubConfig: MigrationHubConfig; readonly MigrationHubOrchestrator: MigrationHubOrchestrator; readonly MigrationHubRefactorSpaces: MigrationHubRefactorSpaces; readonly MigrationHubStrategy: MigrationHubStrategy; readonly Mobile: Mobile; readonly MobileAnalytics: MobileAnalytics; readonly Neptune: Neptune; readonly NetworkFirewall: NetworkFirewall; readonly NetworkManager: NetworkManager; readonly Nimble: Nimble; readonly OpenSearch: OpenSearch; readonly OpsWorks: OpsWorks; readonly OpsWorksCM: OpsWorksCM; readonly Organizations: Organizations; readonly Outposts: Outposts; readonly PI: PI; readonly Panorama: Panorama; readonly Personalize: Personalize; readonly PersonalizeEvents: PersonalizeEvents; readonly PersonalizeRuntime: PersonalizeRuntime; readonly Pinpoint: Pinpoint; readonly PinpointEmail: PinpointEmail; readonly PinpointSMSVoice: PinpointSMSVoice; readonly PinpointSMSVoiceV2: PinpointSMSVoiceV2; readonly Polly: Polly; readonly Pricing: Pricing; readonly PrivateNetworks: PrivateNetworks; readonly Proton: Proton; readonly QLDB: QLDB; readonly QLDBSession: QLDBSession; readonly QuickSight: QuickSight; readonly RAM: RAM; readonly RDS: RDS; readonly RDSDataService: RDSDataService; readonly RUM: RUM; readonly Rbin: Rbin; readonly Redshift: Redshift; readonly RedshiftData: RedshiftData; readonly RedshiftServerless: RedshiftServerless; readonly Rekognition: Rekognition; readonly Resiliencehub: Resiliencehub; readonly ResourceGroups: ResourceGroups; readonly ResourceGroupsTaggingAPI: ResourceGroupsTaggingAPI; readonly RoboMaker: RoboMaker; readonly RolesAnywhere: RolesAnywhere; readonly Route53: Route53; readonly Route53Domains: Route53Domains; readonly Route53RecoveryCluster: Route53RecoveryCluster; readonly Route53RecoveryControlConfig: Route53RecoveryControlConfig; readonly Route53RecoveryReadiness: Route53RecoveryReadiness; readonly Route53Resolver: Route53Resolver; readonly S3: S3; readonly S3Control: S3Control; readonly S3Outposts: S3Outposts; readonly SES: SES; readonly SESV2: SESV2; readonly SMS: SMS; readonly SNS: SNS; readonly SQS: SQS; readonly SSM: SSM; readonly SSMContacts: SSMContacts; readonly SSMIncidents: SSMIncidents; readonly SSO: SSO; readonly SSOAdmin: SSOAdmin; readonly SSOOIDC: SSOOIDC; readonly STS: STS; readonly SWF: SWF; readonly SageMaker: SageMaker; readonly SageMakerFeatureStoreRuntime: SageMakerFeatureStoreRuntime; readonly SageMakerRuntime: SageMakerRuntime; readonly SagemakerEdge: SagemakerEdge; readonly SavingsPlans: SavingsPlans; readonly Schemas: Schemas; readonly SecretsManager: SecretsManager; readonly SecurityHub: SecurityHub; readonly ServerlessApplicationRepository: ServerlessApplicationRepository; readonly ServiceCatalog: ServiceCatalog; readonly ServiceCatalogAppRegistry: ServiceCatalogAppRegistry; readonly ServiceDiscovery: ServiceDiscovery; readonly ServiceQuotas: ServiceQuotas; readonly Shield: Shield; readonly Signer: Signer; readonly SimpleDB: SimpleDB; readonly SnowDeviceManagement: SnowDeviceManagement; readonly Snowball: Snowball; readonly StepFunctions: StepFunctions; readonly StorageGateway: StorageGateway; readonly Support: Support; readonly SupportApp: SupportApp; readonly Synthetics: Synthetics; readonly Textract: Textract; readonly TimestreamQuery: TimestreamQuery; readonly TimestreamWrite: TimestreamWrite; readonly TranscribeService: TranscribeService; readonly Transfer: Transfer; readonly Translate: Translate; readonly VoiceID: VoiceID; readonly WAF: WAF; readonly WAFRegional: WAFRegional; readonly WAFV2: WAFV2; readonly WellArchitected: WellArchitected; readonly Wisdom: Wisdom; readonly WorkDocs: WorkDocs; readonly WorkLink: WorkLink; readonly WorkMail: WorkMail; readonly WorkMailMessageFlow: WorkMailMessageFlow; readonly WorkSpaces: WorkSpaces; readonly WorkSpacesWeb: WorkSpacesWeb; readonly XRay: XRay; } export interface AccessAnalyzer { /** * Retroactively applies the archive rule to existing findings that meet the archive rule criteria. */ applyArchiveRule(input: AWS.AccessAnalyzer.ApplyArchiveRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Cancels the requested policy generation. */ cancelPolicyGeneration(input: AWS.AccessAnalyzer.CancelPolicyGenerationRequest, options: SdkCallOptions): Promise; /** * Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions. */ createAccessPreview(input: AWS.AccessAnalyzer.CreateAccessPreviewRequest, options: SdkCallOptions): Promise; /** * Creates an analyzer for your account. */ createAnalyzer(input: AWS.AccessAnalyzer.CreateAnalyzerRequest, options: SdkCallOptions): Promise; /** * Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide. */ createArchiveRule(input: AWS.AccessAnalyzer.CreateArchiveRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action. */ deleteAnalyzer(input: AWS.AccessAnalyzer.DeleteAnalyzerRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified archive rule. */ deleteArchiveRule(input: AWS.AccessAnalyzer.DeleteArchiveRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves information about an access preview for the specified analyzer. */ getAccessPreview(input: AWS.AccessAnalyzer.GetAccessPreviewRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a resource that was analyzed. */ getAnalyzedResource(input: AWS.AccessAnalyzer.GetAnalyzedResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified analyzer. */ getAnalyzer(input: AWS.AccessAnalyzer.GetAnalyzerRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an archive rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide. */ getArchiveRule(input: AWS.AccessAnalyzer.GetArchiveRuleRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified finding. */ getFinding(input: AWS.AccessAnalyzer.GetFindingRequest, options: SdkCallOptions): Promise; /** * Retrieves the policy that was generated using StartPolicyGeneration. */ getGeneratedPolicy(input: AWS.AccessAnalyzer.GetGeneratedPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of access preview findings generated by the specified access preview. */ listAccessPreviewFindings(input: AWS.AccessAnalyzer.ListAccessPreviewFindingsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of access previews for the specified analyzer. */ listAccessPreviews(input: AWS.AccessAnalyzer.ListAccessPreviewsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer.. */ listAnalyzedResources(input: AWS.AccessAnalyzer.ListAnalyzedResourcesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of analyzers. */ listAnalyzers(input: AWS.AccessAnalyzer.ListAnalyzersRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of archive rules created for the specified analyzer. */ listArchiveRules(input: AWS.AccessAnalyzer.ListArchiveRulesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of findings generated by the specified analyzer. To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide. */ listFindings(input: AWS.AccessAnalyzer.ListFindingsRequest, options: SdkCallOptions): Promise; /** * Lists all of the policy generations requested in the last seven days. */ listPolicyGenerations(input: AWS.AccessAnalyzer.ListPolicyGenerationsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of tags applied to the specified resource. */ listTagsForResource(input: AWS.AccessAnalyzer.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts the policy generation request. */ startPolicyGeneration(input: AWS.AccessAnalyzer.StartPolicyGenerationRequest, options: SdkCallOptions): Promise; /** * Immediately starts a scan of the policies applied to the specified resource. */ startResourceScan(input: AWS.AccessAnalyzer.StartResourceScanRequest, options: SdkCallOptions): Promise<{}>; /** * Adds a tag to the specified resource. */ tagResource(input: AWS.AccessAnalyzer.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from the specified resource. */ untagResource(input: AWS.AccessAnalyzer.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the criteria and values for the specified archive rule. */ updateArchiveRule(input: AWS.AccessAnalyzer.UpdateArchiveRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the status for the specified findings. */ updateFindings(input: AWS.AccessAnalyzer.UpdateFindingsRequest, options: SdkCallOptions): Promise<{}>; /** * Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices. */ validatePolicy(input: AWS.AccessAnalyzer.ValidatePolicyRequest, options: SdkCallOptions): Promise; } export interface Account { /** * 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(input: AWS.Account.DeleteAlternateContactRequest, options: SdkCallOptions): Promise<{}>; /** * 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(input: AWS.Account.GetAlternateContactRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.Account.GetContactInformationRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.Account.PutAlternateContactRequest, options: SdkCallOptions): Promise<{}>; /** * 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(input: AWS.Account.PutContactInformationRequest, options: SdkCallOptions): Promise<{}>; } export interface ACM { /** * 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(input: AWS.ACM.AddTagsToCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * 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(input: AWS.ACM.DeleteCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * 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(input: AWS.ACM.DescribeCertificateRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.ACM.ExportCertificateRequest, options: SdkCallOptions): Promise; /** * Retrieves an Amazon-issued certificate and its certificate chain. 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(input: AWS.ACM.GetCertificateRequest, options: SdkCallOptions): Promise; /** * 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). If the certificate you are importing is not self-signed, you must enter its certificate chain. If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain. 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(input: AWS.ACM.ImportCertificateRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters. */ listCertificates(input: AWS.ACM.ListCertificatesRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.ACM.ListTagsForCertificateRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.ACM.PutAccountConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * 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(input: AWS.ACM.RemoveTagsFromCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM 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(input: AWS.ACM.RenewCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * 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(input: AWS.ACM.RequestCertificateRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.ACM.ResendValidationEmailRequest, options: SdkCallOptions): Promise<{}>; /** * 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(input: AWS.ACM.UpdateCertificateOptionsRequest, options: SdkCallOptions): Promise<{}>; } export interface ACMPCA { /** * Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA. ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs. Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3. */ createCertificateAuthority(input: AWS.ACMPCA.CreateCertificateAuthorityRequest, options: SdkCallOptions): Promise; /** * Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key. Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3. ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports. You can generate a maximum of one report every 30 minutes. */ createCertificateAuthorityAuditReport(input: AWS.ACMPCA.CreateCertificateAuthorityAuditReportRequest, options: SdkCallOptions): Promise; /** * Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action. About Permissions If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals. For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates. If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA. */ createPermission(input: AWS.ACMPCA.CreatePermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action. Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy. Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED. Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE). When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action. */ deleteCertificateAuthority(input: AWS.ACMPCA.DeleteCertificateAuthorityRequest, options: SdkCallOptions): Promise<{}>; /** * Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically. Permissions can be granted with the CreatePermission action and listed with the ListPermissions action. About Permissions If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals. For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates. If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA. */ deletePermission(input: AWS.ACMPCA.DeletePermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful. If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included. The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy. The current policy can be shown with GetPolicy and updated with PutPolicy. About Policies A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA. A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account. For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM. Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access. */ deletePolicy(input: AWS.ACMPCA.DeletePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: CREATING - ACM Private CA is creating your private certificate authority. PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. ACTIVE - Your private CA is active. DISABLED - Your private CA has been disabled. EXPIRED - Your private CA certificate has expired. FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA. DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output. */ describeCertificateAuthority(input: AWS.ACMPCA.DescribeCertificateAuthorityRequest, options: SdkCallOptions): Promise; /** * Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action. */ describeCertificateAuthorityAuditReport(input: AWS.ACMPCA.DescribeCertificateAuthorityAuditReportRequest, options: SdkCallOptions): Promise; /** * Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA. */ getCertificate(input: AWS.ACMPCA.GetCertificateRequest, options: SdkCallOptions): Promise; /** * Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it. */ getCertificateAuthorityCertificate(input: AWS.ACMPCA.GetCertificateAuthorityCertificateRequest, options: SdkCallOptions): Promise; /** * Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string. */ getCertificateAuthorityCsr(input: AWS.ACMPCA.GetCertificateAuthorityCsrRequest, options: SdkCallOptions): Promise; /** * Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException. The policy can be attached or updated with PutPolicy and removed with DeletePolicy. About Policies A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA. A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account. For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM. Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access. */ getPolicy(input: AWS.ACMPCA.GetPolicyRequest, options: SdkCallOptions): Promise; /** * Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place: In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR). Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. ACM Private CA supports three scenarios for installing a CA certificate: Installing a certificate for a root CA hosted by ACM Private CA. Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA. Installing a subordinate CA certificate whose parent authority is externally hosted. The following additional requirements apply when you import a CA certificate. Only a self-signed certificate can be imported as a root CA. A self-signed certificate cannot be imported as a subordinate CA. Your certificate chain must not include the private CA certificate that you are importing. Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. The chain must be PEM-encoded. The maximum allowed size of a certificate is 32 KB. The maximum allowed size of a certificate chain is 2 MB. Enforcement of Critical Constraints ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain. Basic constraints (must be marked critical) Subject alternative names Key usage Extended key usage Authority key identifier Subject key identifier Issuer alternative name Subject directory attributes Subject information access Certificate policies Policy mappings Inhibit anyPolicy ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain. Name constraints Policy constraints CRL distribution points Authority information access Freshest CRL Any other extension */ importCertificateAuthorityCertificate(input: AWS.ACMPCA.ImportCertificateAuthorityCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN. You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA. */ issueCertificate(input: AWS.ACMPCA.IssueCertificateRequest, options: SdkCallOptions): Promise; /** * Lists the private certificate authorities that you created by using the CreateCertificateAuthority action. */ listCertificateAuthorities(input: AWS.ACMPCA.ListCertificateAuthoritiesRequest, options: SdkCallOptions): Promise; /** * List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action. About Permissions If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals. For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates. If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA. */ listPermissions(input: AWS.ACMPCA.ListPermissionsRequest, options: SdkCallOptions): Promise; /** * Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags. */ listTags(input: AWS.ACMPCA.ListTagsRequest, options: SdkCallOptions): Promise; /** * Attaches a resource-based policy to a private CA. A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access. The policy can be displayed with GetPolicy and removed with DeletePolicy. About Policies A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA. A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account. For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM. Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access. */ putPolicy(input: AWS.ACMPCA.PutPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended. */ restoreCertificateAuthority(input: AWS.ACMPCA.RestoreCertificateAuthorityRequest, options: SdkCallOptions): Promise<{}>; /** * Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics. Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3. ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport. You cannot revoke a root CA self-signed certificate. */ revokeCertificate(input: AWS.ACMPCA.RevokeCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to your private CA. 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 private CA 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 private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA. */ tagCertificateAuthority(input: AWS.ACMPCA.TagCertificateAuthorityRequest, options: SdkCallOptions): Promise<{}>; /** * Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, 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 private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA. */ untagCertificateAuthority(input: AWS.ACMPCA.UntagCertificateAuthorityRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again. Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3. */ updateCertificateAuthority(input: AWS.ACMPCA.UpdateCertificateAuthorityRequest, options: SdkCallOptions): Promise<{}>; } export interface AlexaForBusiness { /** * Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement. */ approveSkill(input: AWS.AlexaForBusiness.ApproveSkillRequest, options: SdkCallOptions): Promise; /** * Associates a contact with a given address book. */ associateContactWithAddressBook(input: AWS.AlexaForBusiness.AssociateContactWithAddressBookRequest, options: SdkCallOptions): Promise; /** * Associates a device with the specified network profile. */ associateDeviceWithNetworkProfile(input: AWS.AlexaForBusiness.AssociateDeviceWithNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required. */ associateDeviceWithRoom(input: AWS.AlexaForBusiness.AssociateDeviceWithRoomRequest, options: SdkCallOptions): Promise; /** * Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room. */ associateSkillGroupWithRoom(input: AWS.AlexaForBusiness.AssociateSkillGroupWithRoomRequest, options: SdkCallOptions): Promise; /** * Associates a skill with a skill group. */ associateSkillWithSkillGroup(input: AWS.AlexaForBusiness.AssociateSkillWithSkillGroupRequest, options: SdkCallOptions): Promise; /** * Makes a private skill available for enrolled users to enable on their devices. */ associateSkillWithUsers(input: AWS.AlexaForBusiness.AssociateSkillWithUsersRequest, options: SdkCallOptions): Promise; /** * Creates an address book with the specified details. */ createAddressBook(input: AWS.AlexaForBusiness.CreateAddressBookRequest, options: SdkCallOptions): Promise; /** * Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval. */ createBusinessReportSchedule(input: AWS.AlexaForBusiness.CreateBusinessReportScheduleRequest, options: SdkCallOptions): Promise; /** * Adds a new conference provider under the user's AWS account. */ createConferenceProvider(input: AWS.AlexaForBusiness.CreateConferenceProviderRequest, options: SdkCallOptions): Promise; /** * Creates a contact with the specified details. */ createContact(input: AWS.AlexaForBusiness.CreateContactRequest, options: SdkCallOptions): Promise; /** * Creates a gateway group with the specified details. */ createGatewayGroup(input: AWS.AlexaForBusiness.CreateGatewayGroupRequest, options: SdkCallOptions): Promise; /** * Creates a network profile with the specified details. */ createNetworkProfile(input: AWS.AlexaForBusiness.CreateNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Creates a new room profile with the specified details. */ createProfile(input: AWS.AlexaForBusiness.CreateProfileRequest, options: SdkCallOptions): Promise; /** * Creates a room with the specified details. */ createRoom(input: AWS.AlexaForBusiness.CreateRoomRequest, options: SdkCallOptions): Promise; /** * Creates a skill group with a specified name and description. */ createSkillGroup(input: AWS.AlexaForBusiness.CreateSkillGroupRequest, options: SdkCallOptions): Promise; /** * Creates a user. */ createUser(input: AWS.AlexaForBusiness.CreateUserRequest, options: SdkCallOptions): Promise; /** * Deletes an address book by the address book ARN. */ deleteAddressBook(input: AWS.AlexaForBusiness.DeleteAddressBookRequest, options: SdkCallOptions): Promise; /** * Deletes the recurring report delivery schedule with the specified schedule ARN. */ deleteBusinessReportSchedule(input: AWS.AlexaForBusiness.DeleteBusinessReportScheduleRequest, options: SdkCallOptions): Promise; /** * Deletes a conference provider. */ deleteConferenceProvider(input: AWS.AlexaForBusiness.DeleteConferenceProviderRequest, options: SdkCallOptions): Promise; /** * Deletes a contact by the contact ARN. */ deleteContact(input: AWS.AlexaForBusiness.DeleteContactRequest, options: SdkCallOptions): Promise; /** * Removes a device from Alexa For Business. */ deleteDevice(input: AWS.AlexaForBusiness.DeleteDeviceRequest, options: SdkCallOptions): Promise; /** * When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device. */ deleteDeviceUsageData(input: AWS.AlexaForBusiness.DeleteDeviceUsageDataRequest, options: SdkCallOptions): Promise; /** * Deletes a gateway group. */ deleteGatewayGroup(input: AWS.AlexaForBusiness.DeleteGatewayGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a network profile by the network profile ARN. */ deleteNetworkProfile(input: AWS.AlexaForBusiness.DeleteNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a room profile by the profile ARN. */ deleteProfile(input: AWS.AlexaForBusiness.DeleteProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a room by the room ARN. */ deleteRoom(input: AWS.AlexaForBusiness.DeleteRoomRequest, options: SdkCallOptions): Promise; /** * Deletes room skill parameter details by room, skill, and parameter key ID. */ deleteRoomSkillParameter(input: AWS.AlexaForBusiness.DeleteRoomSkillParameterRequest, options: SdkCallOptions): Promise; /** * Unlinks a third-party account from a skill. */ deleteSkillAuthorization(input: AWS.AlexaForBusiness.DeleteSkillAuthorizationRequest, options: SdkCallOptions): Promise; /** * Deletes a skill group by skill group ARN. */ deleteSkillGroup(input: AWS.AlexaForBusiness.DeleteSkillGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a specified user by user ARN and enrollment ARN. */ deleteUser(input: AWS.AlexaForBusiness.DeleteUserRequest, options: SdkCallOptions): Promise; /** * Disassociates a contact from a given address book. */ disassociateContactFromAddressBook(input: AWS.AlexaForBusiness.DisassociateContactFromAddressBookRequest, options: SdkCallOptions): Promise; /** * Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room. */ disassociateDeviceFromRoom(input: AWS.AlexaForBusiness.DisassociateDeviceFromRoomRequest, options: SdkCallOptions): Promise; /** * Disassociates a skill from a skill group. */ disassociateSkillFromSkillGroup(input: AWS.AlexaForBusiness.DisassociateSkillFromSkillGroupRequest, options: SdkCallOptions): Promise; /** * Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices. */ disassociateSkillFromUsers(input: AWS.AlexaForBusiness.DisassociateSkillFromUsersRequest, options: SdkCallOptions): Promise; /** * Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room. */ disassociateSkillGroupFromRoom(input: AWS.AlexaForBusiness.DisassociateSkillGroupFromRoomRequest, options: SdkCallOptions): Promise; /** * Forgets smart home appliances associated to a room. */ forgetSmartHomeAppliances(input: AWS.AlexaForBusiness.ForgetSmartHomeAppliancesRequest, options: SdkCallOptions): Promise; /** * Gets address the book details by the address book ARN. */ getAddressBook(input: AWS.AlexaForBusiness.GetAddressBookRequest, options: SdkCallOptions): Promise; /** * Retrieves the existing conference preferences. */ getConferencePreference(input: AWS.AlexaForBusiness.GetConferencePreferenceRequest, options: SdkCallOptions): Promise; /** * Gets details about a specific conference provider. */ getConferenceProvider(input: AWS.AlexaForBusiness.GetConferenceProviderRequest, options: SdkCallOptions): Promise; /** * Gets the contact details by the contact ARN. */ getContact(input: AWS.AlexaForBusiness.GetContactRequest, options: SdkCallOptions): Promise; /** * Gets the details of a device by device ARN. */ getDevice(input: AWS.AlexaForBusiness.GetDeviceRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a gateway. */ getGateway(input: AWS.AlexaForBusiness.GetGatewayRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a gateway group. */ getGatewayGroup(input: AWS.AlexaForBusiness.GetGatewayGroupRequest, options: SdkCallOptions): Promise; /** * Retrieves the configured values for the user enrollment invitation email template. */ getInvitationConfiguration(input: AWS.AlexaForBusiness.GetInvitationConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets the network profile details by the network profile ARN. */ getNetworkProfile(input: AWS.AlexaForBusiness.GetNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Gets the details of a room profile by profile ARN. */ getProfile(input: AWS.AlexaForBusiness.GetProfileRequest, options: SdkCallOptions): Promise; /** * Gets room details by room ARN. */ getRoom(input: AWS.AlexaForBusiness.GetRoomRequest, options: SdkCallOptions): Promise; /** * Gets room skill parameter details by room, skill, and parameter key ARN. */ getRoomSkillParameter(input: AWS.AlexaForBusiness.GetRoomSkillParameterRequest, options: SdkCallOptions): Promise; /** * Gets skill group details by skill group ARN. */ getSkillGroup(input: AWS.AlexaForBusiness.GetSkillGroupRequest, options: SdkCallOptions): Promise; /** * Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours. */ listBusinessReportSchedules(input: AWS.AlexaForBusiness.ListBusinessReportSchedulesRequest, options: SdkCallOptions): Promise; /** * Lists conference providers under a specific AWS account. */ listConferenceProviders(input: AWS.AlexaForBusiness.ListConferenceProvidersRequest, options: SdkCallOptions): Promise; /** * Lists the device event history, including device connection status, for up to 30 days. */ listDeviceEvents(input: AWS.AlexaForBusiness.ListDeviceEventsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group. */ listGatewayGroups(input: AWS.AlexaForBusiness.ListGatewayGroupsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN. */ listGateways(input: AWS.AlexaForBusiness.ListGatewaysRequest, options: SdkCallOptions): Promise; /** * Lists all enabled skills in a specific skill group. */ listSkills(input: AWS.AlexaForBusiness.ListSkillsRequest, options: SdkCallOptions): Promise; /** * Lists all categories in the Alexa skill store. */ listSkillsStoreCategories(input: AWS.AlexaForBusiness.ListSkillsStoreCategoriesRequest, options: SdkCallOptions): Promise; /** * Lists all skills in the Alexa skill store by category. */ listSkillsStoreSkillsByCategory(input: AWS.AlexaForBusiness.ListSkillsStoreSkillsByCategoryRequest, options: SdkCallOptions): Promise; /** * Lists all of the smart home appliances associated with a room. */ listSmartHomeAppliances(input: AWS.AlexaForBusiness.ListSmartHomeAppliancesRequest, options: SdkCallOptions): Promise; /** * Lists all tags for the specified resource. */ listTags(input: AWS.AlexaForBusiness.ListTagsRequest, options: SdkCallOptions): Promise; /** * Sets the conference preferences on a specific conference provider at the account level. */ putConferencePreference(input: AWS.AlexaForBusiness.PutConferencePreferenceRequest, options: SdkCallOptions): Promise; /** * Configures the email template for the user enrollment invitation with the specified attributes. */ putInvitationConfiguration(input: AWS.AlexaForBusiness.PutInvitationConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter. */ putRoomSkillParameter(input: AWS.AlexaForBusiness.PutRoomSkillParameterRequest, options: SdkCallOptions): Promise; /** * Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role. */ putSkillAuthorization(input: AWS.AlexaForBusiness.PutSkillAuthorizationRequest, options: SdkCallOptions): Promise; /** * Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS). */ registerAVSDevice(input: AWS.AlexaForBusiness.RegisterAVSDeviceRequest, options: SdkCallOptions): Promise; /** * Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API. */ rejectSkill(input: AWS.AlexaForBusiness.RejectSkillRequest, options: SdkCallOptions): Promise; /** * Determines the details for the room from which a skill request was invoked. This operation is used by skill developers. To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID. */ resolveRoom(input: AWS.AlexaForBusiness.ResolveRoomRequest, options: SdkCallOptions): Promise; /** * Revokes an invitation and invalidates the enrollment URL. */ revokeInvitation(input: AWS.AlexaForBusiness.RevokeInvitationRequest, options: SdkCallOptions): Promise; /** * Searches address books and lists the ones that meet a set of filter and sort criteria. */ searchAddressBooks(input: AWS.AlexaForBusiness.SearchAddressBooksRequest, options: SdkCallOptions): Promise; /** * Searches contacts and lists the ones that meet a set of filter and sort criteria. */ searchContacts(input: AWS.AlexaForBusiness.SearchContactsRequest, options: SdkCallOptions): Promise; /** * Searches devices and lists the ones that meet a set of filter criteria. */ searchDevices(input: AWS.AlexaForBusiness.SearchDevicesRequest, options: SdkCallOptions): Promise; /** * Searches network profiles and lists the ones that meet a set of filter and sort criteria. */ searchNetworkProfiles(input: AWS.AlexaForBusiness.SearchNetworkProfilesRequest, options: SdkCallOptions): Promise; /** * Searches room profiles and lists the ones that meet a set of filter criteria. */ searchProfiles(input: AWS.AlexaForBusiness.SearchProfilesRequest, options: SdkCallOptions): Promise; /** * Searches rooms and lists the ones that meet a set of filter and sort criteria. */ searchRooms(input: AWS.AlexaForBusiness.SearchRoomsRequest, options: SdkCallOptions): Promise; /** * Searches skill groups and lists the ones that meet a set of filter and sort criteria. */ searchSkillGroups(input: AWS.AlexaForBusiness.SearchSkillGroupsRequest, options: SdkCallOptions): Promise; /** * Searches users and lists the ones that meet a set of filter and sort criteria. */ searchUsers(input: AWS.AlexaForBusiness.SearchUsersRequest, options: SdkCallOptions): Promise; /** * Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter. */ sendAnnouncement(input: AWS.AlexaForBusiness.SendAnnouncementRequest, options: SdkCallOptions): Promise; /** * Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first. */ sendInvitation(input: AWS.AlexaForBusiness.SendInvitationRequest, options: SdkCallOptions): Promise; /** * Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways: Bluetooth - This unpairs all bluetooth devices paired with your echo device. Volume - This resets the echo device's volume to the default value. Notifications - This clears all notifications from your echo device. Lists - This clears all to-do items from your echo device. Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile). */ startDeviceSync(input: AWS.AlexaForBusiness.StartDeviceSyncRequest, options: SdkCallOptions): Promise; /** * Initiates the discovery of any smart home appliances associated with the room. */ startSmartHomeApplianceDiscovery(input: AWS.AlexaForBusiness.StartSmartHomeApplianceDiscoveryRequest, options: SdkCallOptions): Promise; /** * Adds metadata tags to a specified resource. */ tagResource(input: AWS.AlexaForBusiness.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes metadata tags from a specified resource. */ untagResource(input: AWS.AlexaForBusiness.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates address book details by the address book ARN. */ updateAddressBook(input: AWS.AlexaForBusiness.UpdateAddressBookRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of the report delivery schedule with the specified schedule ARN. */ updateBusinessReportSchedule(input: AWS.AlexaForBusiness.UpdateBusinessReportScheduleRequest, options: SdkCallOptions): Promise; /** * Updates an existing conference provider's settings. */ updateConferenceProvider(input: AWS.AlexaForBusiness.UpdateConferenceProviderRequest, options: SdkCallOptions): Promise; /** * Updates the contact details by the contact ARN. */ updateContact(input: AWS.AlexaForBusiness.UpdateContactRequest, options: SdkCallOptions): Promise; /** * Updates the device name by device ARN. */ updateDevice(input: AWS.AlexaForBusiness.UpdateDeviceRequest, options: SdkCallOptions): Promise; /** * Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified. */ updateGateway(input: AWS.AlexaForBusiness.UpdateGatewayRequest, options: SdkCallOptions): Promise; /** * Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified. */ updateGatewayGroup(input: AWS.AlexaForBusiness.UpdateGatewayGroupRequest, options: SdkCallOptions): Promise; /** * Updates a network profile by the network profile ARN. */ updateNetworkProfile(input: AWS.AlexaForBusiness.UpdateNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Updates an existing room profile by room profile ARN. */ updateProfile(input: AWS.AlexaForBusiness.UpdateProfileRequest, options: SdkCallOptions): Promise; /** * Updates room details by room ARN. */ updateRoom(input: AWS.AlexaForBusiness.UpdateRoomRequest, options: SdkCallOptions): Promise; /** * Updates skill group details by skill group ARN. */ updateSkillGroup(input: AWS.AlexaForBusiness.UpdateSkillGroupRequest, options: SdkCallOptions): Promise; } export interface Amp { /** * Create an alert manager definition. */ createAlertManagerDefinition(input: AWS.Amp.CreateAlertManagerDefinitionRequest, options: SdkCallOptions): Promise; /** * Create logging configuration. */ createLoggingConfiguration(input: AWS.Amp.CreateLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Create a rule group namespace. */ createRuleGroupsNamespace(input: AWS.Amp.CreateRuleGroupsNamespaceRequest, options: SdkCallOptions): Promise; /** * Creates a new AMP workspace. */ createWorkspace(input: AWS.Amp.CreateWorkspaceRequest, options: SdkCallOptions): Promise; /** * Deletes an alert manager definition. */ deleteAlertManagerDefinition(input: AWS.Amp.DeleteAlertManagerDefinitionRequest, options: SdkCallOptions): Promise<{}>; /** * Delete logging configuration. */ deleteLoggingConfiguration(input: AWS.Amp.DeleteLoggingConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a rule groups namespace. */ deleteRuleGroupsNamespace(input: AWS.Amp.DeleteRuleGroupsNamespaceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an AMP workspace. */ deleteWorkspace(input: AWS.Amp.DeleteWorkspaceRequest, options: SdkCallOptions): Promise<{}>; /** * Describes an alert manager definition. */ describeAlertManagerDefinition(input: AWS.Amp.DescribeAlertManagerDefinitionRequest, options: SdkCallOptions): Promise; /** * Describes logging configuration. */ describeLoggingConfiguration(input: AWS.Amp.DescribeLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Describe a rule groups namespace. */ describeRuleGroupsNamespace(input: AWS.Amp.DescribeRuleGroupsNamespaceRequest, options: SdkCallOptions): Promise; /** * Describes an existing AMP workspace. */ describeWorkspace(input: AWS.Amp.DescribeWorkspaceRequest, options: SdkCallOptions): Promise; /** * Lists rule groups namespaces. */ listRuleGroupsNamespaces(input: AWS.Amp.ListRuleGroupsNamespacesRequest, options: SdkCallOptions): Promise; /** * Lists the tags you have assigned to the resource. */ listTagsForResource(input: AWS.Amp.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists all AMP workspaces, including workspaces being created or deleted. */ listWorkspaces(input: AWS.Amp.ListWorkspacesRequest, options: SdkCallOptions): Promise; /** * Update an alert manager definition. */ putAlertManagerDefinition(input: AWS.Amp.PutAlertManagerDefinitionRequest, options: SdkCallOptions): Promise; /** * Update a rule groups namespace. */ putRuleGroupsNamespace(input: AWS.Amp.PutRuleGroupsNamespaceRequest, options: SdkCallOptions): Promise; /** * Creates tags for the specified resource. */ tagResource(input: AWS.Amp.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes tags from the specified resource. */ untagResource(input: AWS.Amp.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update logging configuration. */ updateLoggingConfiguration(input: AWS.Amp.UpdateLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates an AMP workspace alias. */ updateWorkspaceAlias(input: AWS.Amp.UpdateWorkspaceAliasRequest, options: SdkCallOptions): Promise<{}>; } export interface Amplify { /** * Creates a new Amplify app. */ createApp(input: AWS.Amplify.CreateAppRequest, options: SdkCallOptions): Promise; /** * Creates a new backend environment for an Amplify app. */ createBackendEnvironment(input: AWS.Amplify.CreateBackendEnvironmentRequest, options: SdkCallOptions): Promise; /** * Creates a new branch for an Amplify app. */ createBranch(input: AWS.Amplify.CreateBranchRequest, options: SdkCallOptions): Promise; /** * Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository. */ createDeployment(input: AWS.Amplify.CreateDeploymentRequest, options: SdkCallOptions): Promise; /** * Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app */ createDomainAssociation(input: AWS.Amplify.CreateDomainAssociationRequest, options: SdkCallOptions): Promise; /** * Creates a new webhook on an Amplify app. */ createWebhook(input: AWS.Amplify.CreateWebhookRequest, options: SdkCallOptions): Promise; /** * Deletes an existing Amplify app specified by an app ID. */ deleteApp(input: AWS.Amplify.DeleteAppRequest, options: SdkCallOptions): Promise; /** * Deletes a backend environment for an Amplify app. */ deleteBackendEnvironment(input: AWS.Amplify.DeleteBackendEnvironmentRequest, options: SdkCallOptions): Promise; /** * Deletes a branch for an Amplify app. */ deleteBranch(input: AWS.Amplify.DeleteBranchRequest, options: SdkCallOptions): Promise; /** * Deletes a domain association for an Amplify app. */ deleteDomainAssociation(input: AWS.Amplify.DeleteDomainAssociationRequest, options: SdkCallOptions): Promise; /** * Deletes a job for a branch of an Amplify app. */ deleteJob(input: AWS.Amplify.DeleteJobRequest, options: SdkCallOptions): Promise; /** * Deletes a webhook. */ deleteWebhook(input: AWS.Amplify.DeleteWebhookRequest, options: SdkCallOptions): Promise; /** * Returns the website access logs for a specific time range using a presigned URL. */ generateAccessLogs(input: AWS.Amplify.GenerateAccessLogsRequest, options: SdkCallOptions): Promise; /** * Returns an existing Amplify app by appID. */ getApp(input: AWS.Amplify.GetAppRequest, options: SdkCallOptions): Promise; /** * Returns the artifact info that corresponds to an artifact id. */ getArtifactUrl(input: AWS.Amplify.GetArtifactUrlRequest, options: SdkCallOptions): Promise; /** * Returns a backend environment for an Amplify app. */ getBackendEnvironment(input: AWS.Amplify.GetBackendEnvironmentRequest, options: SdkCallOptions): Promise; /** * Returns a branch for an Amplify app. */ getBranch(input: AWS.Amplify.GetBranchRequest, options: SdkCallOptions): Promise; /** * Returns the domain information for an Amplify app. */ getDomainAssociation(input: AWS.Amplify.GetDomainAssociationRequest, options: SdkCallOptions): Promise; /** * Returns a job for a branch of an Amplify app. */ getJob(input: AWS.Amplify.GetJobRequest, options: SdkCallOptions): Promise; /** * Returns the webhook information that corresponds to a specified webhook ID. */ getWebhook(input: AWS.Amplify.GetWebhookRequest, options: SdkCallOptions): Promise; /** * Returns a list of the existing Amplify apps. */ listApps(input: AWS.Amplify.ListAppsRequest, options: SdkCallOptions): Promise; /** * Returns a list of artifacts for a specified app, branch, and job. */ listArtifacts(input: AWS.Amplify.ListArtifactsRequest, options: SdkCallOptions): Promise; /** * Lists the backend environments for an Amplify app. */ listBackendEnvironments(input: AWS.Amplify.ListBackendEnvironmentsRequest, options: SdkCallOptions): Promise; /** * Lists the branches of an Amplify app. */ listBranches(input: AWS.Amplify.ListBranchesRequest, options: SdkCallOptions): Promise; /** * Returns the domain associations for an Amplify app. */ listDomainAssociations(input: AWS.Amplify.ListDomainAssociationsRequest, options: SdkCallOptions): Promise; /** * Lists the jobs for a branch of an Amplify app. */ listJobs(input: AWS.Amplify.ListJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags for a specified Amazon Resource Name (ARN). */ listTagsForResource(input: AWS.Amplify.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of webhooks for an Amplify app. */ listWebhooks(input: AWS.Amplify.ListWebhooksRequest, options: SdkCallOptions): Promise; /** * Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository. */ startDeployment(input: AWS.Amplify.StartDeploymentRequest, options: SdkCallOptions): Promise; /** * Starts a new job for a branch of an Amplify app. */ startJob(input: AWS.Amplify.StartJobRequest, options: SdkCallOptions): Promise; /** * Stops a job that is in progress for a branch of an Amplify app. */ stopJob(input: AWS.Amplify.StopJobRequest, options: SdkCallOptions): Promise; /** * Tags the resource with a tag key and value. */ tagResource(input: AWS.Amplify.TagResourceRequest, options: SdkCallOptions): Promise; /** * Untags a resource with a specified Amazon Resource Name (ARN). */ untagResource(input: AWS.Amplify.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing Amplify app. */ updateApp(input: AWS.Amplify.UpdateAppRequest, options: SdkCallOptions): Promise; /** * Updates a branch for an Amplify app. */ updateBranch(input: AWS.Amplify.UpdateBranchRequest, options: SdkCallOptions): Promise; /** * Creates a new domain association for an Amplify app. */ updateDomainAssociation(input: AWS.Amplify.UpdateDomainAssociationRequest, options: SdkCallOptions): Promise; /** * Updates a webhook. */ updateWebhook(input: AWS.Amplify.UpdateWebhookRequest, options: SdkCallOptions): Promise; } export interface AmplifyBackend { /** * This operation clones an existing backend. */ cloneBackend(input: AWS.AmplifyBackend.CloneBackendRequest, options: SdkCallOptions): Promise; /** * This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. */ createBackend(input: AWS.AmplifyBackend.CreateBackendRequest, options: SdkCallOptions): Promise; /** * Creates a new backend API resource. */ createBackendAPI(input: AWS.AmplifyBackend.CreateBackendAPIRequest, options: SdkCallOptions): Promise; /** * Creates a new backend authentication resource. */ createBackendAuth(input: AWS.AmplifyBackend.CreateBackendAuthRequest, options: SdkCallOptions): Promise; /** * Creates a config object for a backend. */ createBackendConfig(input: AWS.AmplifyBackend.CreateBackendConfigRequest, options: SdkCallOptions): Promise; /** * Creates a backend storage resource. */ createBackendStorage(input: AWS.AmplifyBackend.CreateBackendStorageRequest, options: SdkCallOptions): Promise; /** * Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. */ createToken(input: AWS.AmplifyBackend.CreateTokenRequest, options: SdkCallOptions): Promise; /** * Removes an existing environment from your Amplify project. */ deleteBackend(input: AWS.AmplifyBackend.DeleteBackendRequest, options: SdkCallOptions): Promise; /** * Deletes an existing backend API resource. */ deleteBackendAPI(input: AWS.AmplifyBackend.DeleteBackendAPIRequest, options: SdkCallOptions): Promise; /** * Deletes an existing backend authentication resource. */ deleteBackendAuth(input: AWS.AmplifyBackend.DeleteBackendAuthRequest, options: SdkCallOptions): Promise; /** * Removes the specified backend storage resource. */ deleteBackendStorage(input: AWS.AmplifyBackend.DeleteBackendStorageRequest, options: SdkCallOptions): Promise; /** * Deletes the challenge token based on the given appId and sessionId. */ deleteToken(input: AWS.AmplifyBackend.DeleteTokenRequest, options: SdkCallOptions): Promise; /** * Generates a model schema for an existing backend API resource. */ generateBackendAPIModels(input: AWS.AmplifyBackend.GenerateBackendAPIModelsRequest, options: SdkCallOptions): Promise; /** * Provides project-level details for your Amplify UI project. */ getBackend(input: AWS.AmplifyBackend.GetBackendRequest, options: SdkCallOptions): Promise; /** * Gets the details for a backend API. */ getBackendAPI(input: AWS.AmplifyBackend.GetBackendAPIRequest, options: SdkCallOptions): Promise; /** * Generates a model schema for existing backend API resource. */ getBackendAPIModels(input: AWS.AmplifyBackend.GetBackendAPIModelsRequest, options: SdkCallOptions): Promise; /** * Gets a backend auth details. */ getBackendAuth(input: AWS.AmplifyBackend.GetBackendAuthRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific job. */ getBackendJob(input: AWS.AmplifyBackend.GetBackendJobRequest, options: SdkCallOptions): Promise; /** * Gets details for a backend storage resource. */ getBackendStorage(input: AWS.AmplifyBackend.GetBackendStorageRequest, options: SdkCallOptions): Promise; /** * Gets the challenge token based on the given appId and sessionId. */ getToken(input: AWS.AmplifyBackend.GetTokenRequest, options: SdkCallOptions): Promise; /** * Imports an existing backend authentication resource. */ importBackendAuth(input: AWS.AmplifyBackend.ImportBackendAuthRequest, options: SdkCallOptions): Promise; /** * Imports an existing backend storage resource. */ importBackendStorage(input: AWS.AmplifyBackend.ImportBackendStorageRequest, options: SdkCallOptions): Promise; /** * Lists the jobs for the backend of an Amplify app. */ listBackendJobs(input: AWS.AmplifyBackend.ListBackendJobsRequest, options: SdkCallOptions): Promise; /** * The list of S3 buckets in your account. */ listS3Buckets(input: AWS.AmplifyBackend.ListS3BucketsRequest, options: SdkCallOptions): Promise; /** * Removes all backend environments from your Amplify project. */ removeAllBackends(input: AWS.AmplifyBackend.RemoveAllBackendsRequest, options: SdkCallOptions): Promise; /** * Removes the AWS resources required to access the Amplify Admin UI. */ removeBackendConfig(input: AWS.AmplifyBackend.RemoveBackendConfigRequest, options: SdkCallOptions): Promise; /** * Updates an existing backend API resource. */ updateBackendAPI(input: AWS.AmplifyBackend.UpdateBackendAPIRequest, options: SdkCallOptions): Promise; /** * Updates an existing backend authentication resource. */ updateBackendAuth(input: AWS.AmplifyBackend.UpdateBackendAuthRequest, options: SdkCallOptions): Promise; /** * Updates the AWS resources required to access the Amplify Admin UI. */ updateBackendConfig(input: AWS.AmplifyBackend.UpdateBackendConfigRequest, options: SdkCallOptions): Promise; /** * Updates a specific job. */ updateBackendJob(input: AWS.AmplifyBackend.UpdateBackendJobRequest, options: SdkCallOptions): Promise; /** * Updates an existing backend storage resource. */ updateBackendStorage(input: AWS.AmplifyBackend.UpdateBackendStorageRequest, options: SdkCallOptions): Promise; } export interface AmplifyUIBuilder { /** * Creates a new component for an Amplify app. */ createComponent(input: AWS.AmplifyUIBuilder.CreateComponentRequest, options: SdkCallOptions): Promise; /** * Creates a new form for an Amplify app. */ createForm(input: AWS.AmplifyUIBuilder.CreateFormRequest, options: SdkCallOptions): Promise; /** * Creates a theme to apply to the components in an Amplify app. */ createTheme(input: AWS.AmplifyUIBuilder.CreateThemeRequest, options: SdkCallOptions): Promise; /** * Deletes a component from an Amplify app. */ deleteComponent(input: AWS.AmplifyUIBuilder.DeleteComponentRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a form from an Amplify app. */ deleteForm(input: AWS.AmplifyUIBuilder.DeleteFormRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a theme from an Amplify app. */ deleteTheme(input: AWS.AmplifyUIBuilder.DeleteThemeRequest, options: SdkCallOptions): Promise<{}>; /** * Exchanges an access code for a token. */ exchangeCodeForToken(input: AWS.AmplifyUIBuilder.ExchangeCodeForTokenRequest, options: SdkCallOptions): Promise; /** * Exports component configurations to code that is ready to integrate into an Amplify app. */ exportComponents(input: AWS.AmplifyUIBuilder.ExportComponentsRequest, options: SdkCallOptions): Promise; /** * Exports form configurations to code that is ready to integrate into an Amplify app. */ exportForms(input: AWS.AmplifyUIBuilder.ExportFormsRequest, options: SdkCallOptions): Promise; /** * Exports theme configurations to code that is ready to integrate into an Amplify app. */ exportThemes(input: AWS.AmplifyUIBuilder.ExportThemesRequest, options: SdkCallOptions): Promise; /** * Returns an existing component for an Amplify app. */ getComponent(input: AWS.AmplifyUIBuilder.GetComponentRequest, options: SdkCallOptions): Promise; /** * Returns an existing form for an Amplify app. */ getForm(input: AWS.AmplifyUIBuilder.GetFormRequest, options: SdkCallOptions): Promise; /** * Returns existing metadata for an Amplify app. */ getMetadata(input: AWS.AmplifyUIBuilder.GetMetadataRequest, options: SdkCallOptions): Promise; /** * Returns an existing theme for an Amplify app. */ getTheme(input: AWS.AmplifyUIBuilder.GetThemeRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of components for a specified Amplify app and backend environment. */ listComponents(input: AWS.AmplifyUIBuilder.ListComponentsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of forms for a specified Amplify app and backend environment. */ listForms(input: AWS.AmplifyUIBuilder.ListFormsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of themes for a specified Amplify app and backend environment. */ listThemes(input: AWS.AmplifyUIBuilder.ListThemesRequest, options: SdkCallOptions): Promise; /** * Stores the metadata information about a feature on a form or view. */ putMetadataFlag(input: AWS.AmplifyUIBuilder.PutMetadataFlagRequest, options: SdkCallOptions): Promise<{}>; /** * Refreshes a previously issued access token that might have expired. */ refreshToken(input: AWS.AmplifyUIBuilder.RefreshTokenRequest, options: SdkCallOptions): Promise; /** * Updates an existing component. */ updateComponent(input: AWS.AmplifyUIBuilder.UpdateComponentRequest, options: SdkCallOptions): Promise; /** * Updates an existing form. */ updateForm(input: AWS.AmplifyUIBuilder.UpdateFormRequest, options: SdkCallOptions): Promise; /** * Updates an existing theme. */ updateTheme(input: AWS.AmplifyUIBuilder.UpdateThemeRequest, options: SdkCallOptions): Promise; } export interface APIGateway { /** * Create an ApiKey resource. */ createApiKey(input: AWS.APIGateway.CreateApiKeyRequest, options: SdkCallOptions): Promise; /** * Adds a new Authorizer resource to an existing RestApi resource. */ createAuthorizer(input: AWS.APIGateway.CreateAuthorizerRequest, options: SdkCallOptions): Promise; /** * Creates a new BasePathMapping resource. */ createBasePathMapping(input: AWS.APIGateway.CreateBasePathMappingRequest, options: SdkCallOptions): Promise; /** * Creates a Deployment resource, which makes a specified RestApi callable over the internet. */ createDeployment(input: AWS.APIGateway.CreateDeploymentRequest, options: SdkCallOptions): Promise; /** * Creates a documentation part. */ createDocumentationPart(input: AWS.APIGateway.CreateDocumentationPartRequest, options: SdkCallOptions): Promise; /** * Creates a documentation version */ createDocumentationVersion(input: AWS.APIGateway.CreateDocumentationVersionRequest, options: SdkCallOptions): Promise; /** * Creates a new domain name. */ createDomainName(input: AWS.APIGateway.CreateDomainNameRequest, options: SdkCallOptions): Promise; /** * Adds a new Model resource to an existing RestApi resource. */ createModel(input: AWS.APIGateway.CreateModelRequest, options: SdkCallOptions): Promise; /** * Creates a RequestValidator of a given RestApi. */ createRequestValidator(input: AWS.APIGateway.CreateRequestValidatorRequest, options: SdkCallOptions): Promise; /** * Creates a Resource resource. */ createResource(input: AWS.APIGateway.CreateResourceRequest, options: SdkCallOptions): Promise; /** * Creates a new RestApi resource. */ createRestApi(input: AWS.APIGateway.CreateRestApiRequest, options: SdkCallOptions): Promise; /** * Creates a new Stage resource that references a pre-existing Deployment for the API. */ createStage(input: AWS.APIGateway.CreateStageRequest, options: SdkCallOptions): Promise; /** * Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. */ createUsagePlan(input: AWS.APIGateway.CreateUsagePlanRequest, options: SdkCallOptions): Promise; /** * Creates a usage plan key for adding an existing API key to a usage plan. */ createUsagePlanKey(input: AWS.APIGateway.CreateUsagePlanKeyRequest, options: SdkCallOptions): Promise; /** * Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services. */ createVpcLink(input: AWS.APIGateway.CreateVpcLinkRequest, options: SdkCallOptions): Promise; /** * Deletes the ApiKey resource. */ deleteApiKey(input: AWS.APIGateway.DeleteApiKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing Authorizer resource. */ deleteAuthorizer(input: AWS.APIGateway.DeleteAuthorizerRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the BasePathMapping resource. */ deleteBasePathMapping(input: AWS.APIGateway.DeleteBasePathMappingRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the ClientCertificate resource. */ deleteClientCertificate(input: AWS.APIGateway.DeleteClientCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it. */ deleteDeployment(input: AWS.APIGateway.DeleteDeploymentRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a documentation part */ deleteDocumentationPart(input: AWS.APIGateway.DeleteDocumentationPartRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a documentation version. */ deleteDocumentationVersion(input: AWS.APIGateway.DeleteDocumentationVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the DomainName resource. */ deleteDomainName(input: AWS.APIGateway.DeleteDomainNameRequest, options: SdkCallOptions): Promise<{}>; /** * Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. */ deleteGatewayResponse(input: AWS.APIGateway.DeleteGatewayResponseRequest, options: SdkCallOptions): Promise<{}>; /** * Represents a delete integration. */ deleteIntegration(input: AWS.APIGateway.DeleteIntegrationRequest, options: SdkCallOptions): Promise<{}>; /** * Represents a delete integration response. */ deleteIntegrationResponse(input: AWS.APIGateway.DeleteIntegrationResponseRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing Method resource. */ deleteMethod(input: AWS.APIGateway.DeleteMethodRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing MethodResponse resource. */ deleteMethodResponse(input: AWS.APIGateway.DeleteMethodResponseRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a model. */ deleteModel(input: AWS.APIGateway.DeleteModelRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a RequestValidator of a given RestApi. */ deleteRequestValidator(input: AWS.APIGateway.DeleteRequestValidatorRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Resource resource. */ deleteResource(input: AWS.APIGateway.DeleteResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified API. */ deleteRestApi(input: AWS.APIGateway.DeleteRestApiRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Stage resource. */ deleteStage(input: AWS.APIGateway.DeleteStageRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a usage plan of a given plan Id. */ deleteUsagePlan(input: AWS.APIGateway.DeleteUsagePlanRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a usage plan key and remove the underlying API key from the associated usage plan. */ deleteUsagePlanKey(input: AWS.APIGateway.DeleteUsagePlanKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing VpcLink of a specified identifier. */ deleteVpcLink(input: AWS.APIGateway.DeleteVpcLinkRequest, options: SdkCallOptions): Promise<{}>; /** * Flushes all authorizer cache entries on a stage. */ flushStageAuthorizersCache(input: AWS.APIGateway.FlushStageAuthorizersCacheRequest, options: SdkCallOptions): Promise<{}>; /** * Flushes a stage's cache. */ flushStageCache(input: AWS.APIGateway.FlushStageCacheRequest, options: SdkCallOptions): Promise<{}>; /** * Generates a ClientCertificate resource. */ generateClientCertificate(input: AWS.APIGateway.GenerateClientCertificateRequest, options: SdkCallOptions): Promise; /** * Gets information about the current Account resource. */ getAccount(input: AWS.APIGateway.GetAccountRequest, options: SdkCallOptions): Promise; /** * Gets information about the current ApiKey resource. */ getApiKey(input: AWS.APIGateway.GetApiKeyRequest, options: SdkCallOptions): Promise; /** * Gets information about the current ApiKeys resource. */ getApiKeys(input: AWS.APIGateway.GetApiKeysRequest, options: SdkCallOptions): Promise; /** * Describe an existing Authorizer resource. */ getAuthorizer(input: AWS.APIGateway.GetAuthorizerRequest, options: SdkCallOptions): Promise; /** * Describe an existing Authorizers resource. */ getAuthorizers(input: AWS.APIGateway.GetAuthorizersRequest, options: SdkCallOptions): Promise; /** * Describe a BasePathMapping resource. */ getBasePathMapping(input: AWS.APIGateway.GetBasePathMappingRequest, options: SdkCallOptions): Promise; /** * Represents a collection of BasePathMapping resources. */ getBasePathMappings(input: AWS.APIGateway.GetBasePathMappingsRequest, options: SdkCallOptions): Promise; /** * Gets information about the current ClientCertificate resource. */ getClientCertificate(input: AWS.APIGateway.GetClientCertificateRequest, options: SdkCallOptions): Promise; /** * Gets a collection of ClientCertificate resources. */ getClientCertificates(input: AWS.APIGateway.GetClientCertificatesRequest, options: SdkCallOptions): Promise; /** * Gets information about a Deployment resource. */ getDeployment(input: AWS.APIGateway.GetDeploymentRequest, options: SdkCallOptions): Promise; /** * Gets information about a Deployments collection. */ getDeployments(input: AWS.APIGateway.GetDeploymentsRequest, options: SdkCallOptions): Promise; /** * Gets a documentation part. */ getDocumentationPart(input: AWS.APIGateway.GetDocumentationPartRequest, options: SdkCallOptions): Promise; /** * Gets documentation parts. */ getDocumentationParts(input: AWS.APIGateway.GetDocumentationPartsRequest, options: SdkCallOptions): Promise; /** * Gets a documentation version. */ getDocumentationVersion(input: AWS.APIGateway.GetDocumentationVersionRequest, options: SdkCallOptions): Promise; /** * Gets documentation versions. */ getDocumentationVersions(input: AWS.APIGateway.GetDocumentationVersionsRequest, options: SdkCallOptions): Promise; /** * Represents a domain name that is contained in a simpler, more intuitive URL that can be called. */ getDomainName(input: AWS.APIGateway.GetDomainNameRequest, options: SdkCallOptions): Promise; /** * Represents a collection of DomainName resources. */ getDomainNames(input: AWS.APIGateway.GetDomainNamesRequest, options: SdkCallOptions): Promise; /** * Exports a deployed version of a RestApi in a specified format. */ getExport(input: AWS.APIGateway.GetExportRequest, options: SdkCallOptions): Promise; /** * Gets a GatewayResponse of a specified response type on the given RestApi. */ getGatewayResponse(input: AWS.APIGateway.GetGatewayResponseRequest, options: SdkCallOptions): Promise; /** * Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types. */ getGatewayResponses(input: AWS.APIGateway.GetGatewayResponsesRequest, options: SdkCallOptions): Promise; /** * Get the integration settings. */ getIntegration(input: AWS.APIGateway.GetIntegrationRequest, options: SdkCallOptions): Promise; /** * Represents a get integration response. */ getIntegrationResponse(input: AWS.APIGateway.GetIntegrationResponseRequest, options: SdkCallOptions): Promise; /** * Describe an existing Method resource. */ getMethod(input: AWS.APIGateway.GetMethodRequest, options: SdkCallOptions): Promise; /** * Describes a MethodResponse resource. */ getMethodResponse(input: AWS.APIGateway.GetMethodResponseRequest, options: SdkCallOptions): Promise; /** * Describes an existing model defined for a RestApi resource. */ getModel(input: AWS.APIGateway.GetModelRequest, options: SdkCallOptions): Promise; /** * Generates a sample mapping template that can be used to transform a payload into the structure of a model. */ getModelTemplate(input: AWS.APIGateway.GetModelTemplateRequest, options: SdkCallOptions): Promise; /** * Describes existing Models defined for a RestApi resource. */ getModels(input: AWS.APIGateway.GetModelsRequest, options: SdkCallOptions): Promise; /** * Gets a RequestValidator of a given RestApi. */ getRequestValidator(input: AWS.APIGateway.GetRequestValidatorRequest, options: SdkCallOptions): Promise; /** * Gets the RequestValidators collection of a given RestApi. */ getRequestValidators(input: AWS.APIGateway.GetRequestValidatorsRequest, options: SdkCallOptions): Promise; /** * Lists information about a resource. */ getResource(input: AWS.APIGateway.GetResourceRequest, options: SdkCallOptions): Promise; /** * Lists information about a collection of Resource resources. */ getResources(input: AWS.APIGateway.GetResourcesRequest, options: SdkCallOptions): Promise; /** * Lists the RestApi resource in the collection. */ getRestApi(input: AWS.APIGateway.GetRestApiRequest, options: SdkCallOptions): Promise; /** * Lists the RestApis resources for your collection. */ getRestApis(input: AWS.APIGateway.GetRestApisRequest, options: SdkCallOptions): Promise; /** * Generates a client SDK for a RestApi and Stage. */ getSdk(input: AWS.APIGateway.GetSdkRequest, options: SdkCallOptions): Promise; /** * Gets an SDK type. */ getSdkType(input: AWS.APIGateway.GetSdkTypeRequest, options: SdkCallOptions): Promise; /** * Gets SDK types */ getSdkTypes(input: AWS.APIGateway.GetSdkTypesRequest, options: SdkCallOptions): Promise; /** * Gets information about a Stage resource. */ getStage(input: AWS.APIGateway.GetStageRequest, options: SdkCallOptions): Promise; /** * Gets information about one or more Stage resources. */ getStages(input: AWS.APIGateway.GetStagesRequest, options: SdkCallOptions): Promise; /** * Gets the Tags collection for a given resource. */ getTags(input: AWS.APIGateway.GetTagsRequest, options: SdkCallOptions): Promise; /** * Gets the usage data of a usage plan in a specified time interval. */ getUsage(input: AWS.APIGateway.GetUsageRequest, options: SdkCallOptions): Promise; /** * Gets a usage plan of a given plan identifier. */ getUsagePlan(input: AWS.APIGateway.GetUsagePlanRequest, options: SdkCallOptions): Promise; /** * Gets a usage plan key of a given key identifier. */ getUsagePlanKey(input: AWS.APIGateway.GetUsagePlanKeyRequest, options: SdkCallOptions): Promise; /** * Gets all the usage plan keys representing the API keys added to a specified usage plan. */ getUsagePlanKeys(input: AWS.APIGateway.GetUsagePlanKeysRequest, options: SdkCallOptions): Promise; /** * Gets all the usage plans of the caller's account. */ getUsagePlans(input: AWS.APIGateway.GetUsagePlansRequest, options: SdkCallOptions): Promise; /** * Gets a specified VPC link under the caller's account in a region. */ getVpcLink(input: AWS.APIGateway.GetVpcLinkRequest, options: SdkCallOptions): Promise; /** * Gets the VpcLinks collection under the caller's account in a selected region. */ getVpcLinks(input: AWS.APIGateway.GetVpcLinksRequest, options: SdkCallOptions): Promise; /** * Import API keys from an external source, such as a CSV-formatted file. */ importApiKeys(input: AWS.APIGateway.ImportApiKeysRequest, options: SdkCallOptions): Promise; /** * Imports documentation parts */ importDocumentationParts(input: AWS.APIGateway.ImportDocumentationPartsRequest, options: SdkCallOptions): Promise; /** * A feature of the API Gateway control service for creating a new API from an external API definition file. */ importRestApi(input: AWS.APIGateway.ImportRestApiRequest, options: SdkCallOptions): Promise; /** * Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. */ putGatewayResponse(input: AWS.APIGateway.PutGatewayResponseRequest, options: SdkCallOptions): Promise; /** * Sets up a method's integration. */ putIntegration(input: AWS.APIGateway.PutIntegrationRequest, options: SdkCallOptions): Promise; /** * Represents a put integration. */ putIntegrationResponse(input: AWS.APIGateway.PutIntegrationResponseRequest, options: SdkCallOptions): Promise; /** * Add a method to an existing Resource resource. */ putMethod(input: AWS.APIGateway.PutMethodRequest, options: SdkCallOptions): Promise; /** * Adds a MethodResponse to an existing Method resource. */ putMethodResponse(input: AWS.APIGateway.PutMethodResponseRequest, options: SdkCallOptions): Promise; /** * A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API. */ putRestApi(input: AWS.APIGateway.PutRestApiRequest, options: SdkCallOptions): Promise; /** * Adds or updates a tag on a given resource. */ tagResource(input: AWS.APIGateway.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. */ testInvokeAuthorizer(input: AWS.APIGateway.TestInvokeAuthorizerRequest, options: SdkCallOptions): Promise; /** * Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body. */ testInvokeMethod(input: AWS.APIGateway.TestInvokeMethodRequest, options: SdkCallOptions): Promise; /** * Removes a tag from a given resource. */ untagResource(input: AWS.APIGateway.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Changes information about the current Account resource. */ updateAccount(input: AWS.APIGateway.UpdateAccountRequest, options: SdkCallOptions): Promise; /** * Changes information about an ApiKey resource. */ updateApiKey(input: AWS.APIGateway.UpdateApiKeyRequest, options: SdkCallOptions): Promise; /** * Updates an existing Authorizer resource. */ updateAuthorizer(input: AWS.APIGateway.UpdateAuthorizerRequest, options: SdkCallOptions): Promise; /** * Changes information about the BasePathMapping resource. */ updateBasePathMapping(input: AWS.APIGateway.UpdateBasePathMappingRequest, options: SdkCallOptions): Promise; /** * Changes information about an ClientCertificate resource. */ updateClientCertificate(input: AWS.APIGateway.UpdateClientCertificateRequest, options: SdkCallOptions): Promise; /** * Changes information about a Deployment resource. */ updateDeployment(input: AWS.APIGateway.UpdateDeploymentRequest, options: SdkCallOptions): Promise; /** * Updates a documentation part. */ updateDocumentationPart(input: AWS.APIGateway.UpdateDocumentationPartRequest, options: SdkCallOptions): Promise; /** * Updates a documentation version. */ updateDocumentationVersion(input: AWS.APIGateway.UpdateDocumentationVersionRequest, options: SdkCallOptions): Promise; /** * Changes information about the DomainName resource. */ updateDomainName(input: AWS.APIGateway.UpdateDomainNameRequest, options: SdkCallOptions): Promise; /** * Updates a GatewayResponse of a specified response type on the given RestApi. */ updateGatewayResponse(input: AWS.APIGateway.UpdateGatewayResponseRequest, options: SdkCallOptions): Promise; /** * Represents an update integration. */ updateIntegration(input: AWS.APIGateway.UpdateIntegrationRequest, options: SdkCallOptions): Promise; /** * Represents an update integration response. */ updateIntegrationResponse(input: AWS.APIGateway.UpdateIntegrationResponseRequest, options: SdkCallOptions): Promise; /** * Updates an existing Method resource. */ updateMethod(input: AWS.APIGateway.UpdateMethodRequest, options: SdkCallOptions): Promise; /** * Updates an existing MethodResponse resource. */ updateMethodResponse(input: AWS.APIGateway.UpdateMethodResponseRequest, options: SdkCallOptions): Promise; /** * Changes information about a model. */ updateModel(input: AWS.APIGateway.UpdateModelRequest, options: SdkCallOptions): Promise; /** * Updates a RequestValidator of a given RestApi. */ updateRequestValidator(input: AWS.APIGateway.UpdateRequestValidatorRequest, options: SdkCallOptions): Promise; /** * Changes information about a Resource resource. */ updateResource(input: AWS.APIGateway.UpdateResourceRequest, options: SdkCallOptions): Promise; /** * Changes information about the specified API. */ updateRestApi(input: AWS.APIGateway.UpdateRestApiRequest, options: SdkCallOptions): Promise; /** * Changes information about a Stage resource. */ updateStage(input: AWS.APIGateway.UpdateStageRequest, options: SdkCallOptions): Promise; /** * Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. */ updateUsage(input: AWS.APIGateway.UpdateUsageRequest, options: SdkCallOptions): Promise; /** * Updates a usage plan of a given plan Id. */ updateUsagePlan(input: AWS.APIGateway.UpdateUsagePlanRequest, options: SdkCallOptions): Promise; /** * Updates an existing VpcLink of a specified identifier. */ updateVpcLink(input: AWS.APIGateway.UpdateVpcLinkRequest, options: SdkCallOptions): Promise; } export interface ApiGatewayManagementApi { /** * Delete the connection with the provided id. */ deleteConnection(input: AWS.ApiGatewayManagementApi.DeleteConnectionRequest, options: SdkCallOptions): Promise<{}>; /** * Get information about the connection with the provided id. */ getConnection(input: AWS.ApiGatewayManagementApi.GetConnectionRequest, options: SdkCallOptions): Promise; /** * Sends the provided data to the specified connection. */ postToConnection(input: AWS.ApiGatewayManagementApi.PostToConnectionRequest, options: SdkCallOptions): Promise<{}>; } export interface ApiGatewayV2 { /** * Creates an Api resource. */ createApi(input: AWS.ApiGatewayV2.CreateApiRequest, options: SdkCallOptions): Promise; /** * Creates an API mapping. */ createApiMapping(input: AWS.ApiGatewayV2.CreateApiMappingRequest, options: SdkCallOptions): Promise; /** * Creates an Authorizer for an API. */ createAuthorizer(input: AWS.ApiGatewayV2.CreateAuthorizerRequest, options: SdkCallOptions): Promise; /** * Creates a Deployment for an API. */ createDeployment(input: AWS.ApiGatewayV2.CreateDeploymentRequest, options: SdkCallOptions): Promise; /** * Creates a domain name. */ createDomainName(input: AWS.ApiGatewayV2.CreateDomainNameRequest, options: SdkCallOptions): Promise; /** * Creates an Integration. */ createIntegration(input: AWS.ApiGatewayV2.CreateIntegrationRequest, options: SdkCallOptions): Promise; /** * Creates an IntegrationResponses. */ createIntegrationResponse(input: AWS.ApiGatewayV2.CreateIntegrationResponseRequest, options: SdkCallOptions): Promise; /** * Creates a Model for an API. */ createModel(input: AWS.ApiGatewayV2.CreateModelRequest, options: SdkCallOptions): Promise; /** * Creates a Route for an API. */ createRoute(input: AWS.ApiGatewayV2.CreateRouteRequest, options: SdkCallOptions): Promise; /** * Creates a RouteResponse for a Route. */ createRouteResponse(input: AWS.ApiGatewayV2.CreateRouteResponseRequest, options: SdkCallOptions): Promise; /** * Creates a Stage for an API. */ createStage(input: AWS.ApiGatewayV2.CreateStageRequest, options: SdkCallOptions): Promise; /** * Creates a VPC link. */ createVpcLink(input: AWS.ApiGatewayV2.CreateVpcLinkRequest, options: SdkCallOptions): Promise; /** * Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings. */ deleteAccessLogSettings(input: AWS.ApiGatewayV2.DeleteAccessLogSettingsRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an Api resource. */ deleteApi(input: AWS.ApiGatewayV2.DeleteApiRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an API mapping. */ deleteApiMapping(input: AWS.ApiGatewayV2.DeleteApiMappingRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an Authorizer. */ deleteAuthorizer(input: AWS.ApiGatewayV2.DeleteAuthorizerRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a CORS configuration. */ deleteCorsConfiguration(input: AWS.ApiGatewayV2.DeleteCorsConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Deployment. */ deleteDeployment(input: AWS.ApiGatewayV2.DeleteDeploymentRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a domain name. */ deleteDomainName(input: AWS.ApiGatewayV2.DeleteDomainNameRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an Integration. */ deleteIntegration(input: AWS.ApiGatewayV2.DeleteIntegrationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an IntegrationResponses. */ deleteIntegrationResponse(input: AWS.ApiGatewayV2.DeleteIntegrationResponseRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Model. */ deleteModel(input: AWS.ApiGatewayV2.DeleteModelRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Route. */ deleteRoute(input: AWS.ApiGatewayV2.DeleteRouteRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a route request parameter. */ deleteRouteRequestParameter(input: AWS.ApiGatewayV2.DeleteRouteRequestParameterRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a RouteResponse. */ deleteRouteResponse(input: AWS.ApiGatewayV2.DeleteRouteResponseRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the RouteSettings for a stage. */ deleteRouteSettings(input: AWS.ApiGatewayV2.DeleteRouteSettingsRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Stage. */ deleteStage(input: AWS.ApiGatewayV2.DeleteStageRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a VPC link. */ deleteVpcLink(input: AWS.ApiGatewayV2.DeleteVpcLinkRequest, options: SdkCallOptions): Promise; exportApi(input: AWS.ApiGatewayV2.ExportApiRequest, options: SdkCallOptions): Promise; /** * Resets all authorizer cache entries on a stage. Supported only for HTTP APIs. */ resetAuthorizersCache(input: AWS.ApiGatewayV2.ResetAuthorizersCacheRequest, options: SdkCallOptions): Promise<{}>; /** * Gets an Api resource. */ getApi(input: AWS.ApiGatewayV2.GetApiRequest, options: SdkCallOptions): Promise; /** * Gets an API mapping. */ getApiMapping(input: AWS.ApiGatewayV2.GetApiMappingRequest, options: SdkCallOptions): Promise; /** * Gets API mappings. */ getApiMappings(input: AWS.ApiGatewayV2.GetApiMappingsRequest, options: SdkCallOptions): Promise; /** * Gets a collection of Api resources. */ getApis(input: AWS.ApiGatewayV2.GetApisRequest, options: SdkCallOptions): Promise; /** * Gets an Authorizer. */ getAuthorizer(input: AWS.ApiGatewayV2.GetAuthorizerRequest, options: SdkCallOptions): Promise; /** * Gets the Authorizers for an API. */ getAuthorizers(input: AWS.ApiGatewayV2.GetAuthorizersRequest, options: SdkCallOptions): Promise; /** * Gets a Deployment. */ getDeployment(input: AWS.ApiGatewayV2.GetDeploymentRequest, options: SdkCallOptions): Promise; /** * Gets the Deployments for an API. */ getDeployments(input: AWS.ApiGatewayV2.GetDeploymentsRequest, options: SdkCallOptions): Promise; /** * Gets a domain name. */ getDomainName(input: AWS.ApiGatewayV2.GetDomainNameRequest, options: SdkCallOptions): Promise; /** * Gets the domain names for an AWS account. */ getDomainNames(input: AWS.ApiGatewayV2.GetDomainNamesRequest, options: SdkCallOptions): Promise; /** * Gets an Integration. */ getIntegration(input: AWS.ApiGatewayV2.GetIntegrationRequest, options: SdkCallOptions): Promise; /** * Gets an IntegrationResponses. */ getIntegrationResponse(input: AWS.ApiGatewayV2.GetIntegrationResponseRequest, options: SdkCallOptions): Promise; /** * Gets the IntegrationResponses for an Integration. */ getIntegrationResponses(input: AWS.ApiGatewayV2.GetIntegrationResponsesRequest, options: SdkCallOptions): Promise; /** * Gets the Integrations for an API. */ getIntegrations(input: AWS.ApiGatewayV2.GetIntegrationsRequest, options: SdkCallOptions): Promise; /** * Gets a Model. */ getModel(input: AWS.ApiGatewayV2.GetModelRequest, options: SdkCallOptions): Promise; /** * Gets a model template. */ getModelTemplate(input: AWS.ApiGatewayV2.GetModelTemplateRequest, options: SdkCallOptions): Promise; /** * Gets the Models for an API. */ getModels(input: AWS.ApiGatewayV2.GetModelsRequest, options: SdkCallOptions): Promise; /** * Gets a Route. */ getRoute(input: AWS.ApiGatewayV2.GetRouteRequest, options: SdkCallOptions): Promise; /** * Gets a RouteResponse. */ getRouteResponse(input: AWS.ApiGatewayV2.GetRouteResponseRequest, options: SdkCallOptions): Promise; /** * Gets the RouteResponses for a Route. */ getRouteResponses(input: AWS.ApiGatewayV2.GetRouteResponsesRequest, options: SdkCallOptions): Promise; /** * Gets the Routes for an API. */ getRoutes(input: AWS.ApiGatewayV2.GetRoutesRequest, options: SdkCallOptions): Promise; /** * Gets a Stage. */ getStage(input: AWS.ApiGatewayV2.GetStageRequest, options: SdkCallOptions): Promise; /** * Gets the Stages for an API. */ getStages(input: AWS.ApiGatewayV2.GetStagesRequest, options: SdkCallOptions): Promise; /** * Gets a collection of Tag resources. */ getTags(input: AWS.ApiGatewayV2.GetTagsRequest, options: SdkCallOptions): Promise; /** * Gets a VPC link. */ getVpcLink(input: AWS.ApiGatewayV2.GetVpcLinkRequest, options: SdkCallOptions): Promise; /** * Gets a collection of VPC links. */ getVpcLinks(input: AWS.ApiGatewayV2.GetVpcLinksRequest, options: SdkCallOptions): Promise; /** * Imports an API. */ importApi(input: AWS.ApiGatewayV2.ImportApiRequest, options: SdkCallOptions): Promise; /** * Puts an Api resource. */ reimportApi(input: AWS.ApiGatewayV2.ReimportApiRequest, options: SdkCallOptions): Promise; /** * Creates a new Tag resource to represent a tag. */ tagResource(input: AWS.ApiGatewayV2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes a Tag. */ untagResource(input: AWS.ApiGatewayV2.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an Api resource. */ updateApi(input: AWS.ApiGatewayV2.UpdateApiRequest, options: SdkCallOptions): Promise; /** * The API mapping. */ updateApiMapping(input: AWS.ApiGatewayV2.UpdateApiMappingRequest, options: SdkCallOptions): Promise; /** * Updates an Authorizer. */ updateAuthorizer(input: AWS.ApiGatewayV2.UpdateAuthorizerRequest, options: SdkCallOptions): Promise; /** * Updates a Deployment. */ updateDeployment(input: AWS.ApiGatewayV2.UpdateDeploymentRequest, options: SdkCallOptions): Promise; /** * Updates a domain name. */ updateDomainName(input: AWS.ApiGatewayV2.UpdateDomainNameRequest, options: SdkCallOptions): Promise; /** * Updates an Integration. */ updateIntegration(input: AWS.ApiGatewayV2.UpdateIntegrationRequest, options: SdkCallOptions): Promise; /** * Updates an IntegrationResponses. */ updateIntegrationResponse(input: AWS.ApiGatewayV2.UpdateIntegrationResponseRequest, options: SdkCallOptions): Promise; /** * Updates a Model. */ updateModel(input: AWS.ApiGatewayV2.UpdateModelRequest, options: SdkCallOptions): Promise; /** * Updates a Route. */ updateRoute(input: AWS.ApiGatewayV2.UpdateRouteRequest, options: SdkCallOptions): Promise; /** * Updates a RouteResponse. */ updateRouteResponse(input: AWS.ApiGatewayV2.UpdateRouteResponseRequest, options: SdkCallOptions): Promise; /** * Updates a Stage. */ updateStage(input: AWS.ApiGatewayV2.UpdateStageRequest, options: SdkCallOptions): Promise; /** * Updates a VPC link. */ updateVpcLink(input: AWS.ApiGatewayV2.UpdateVpcLinkRequest, options: SdkCallOptions): Promise; } export interface AppConfig { /** * Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users. */ createApplication(input: AWS.AppConfig.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. A configuration profile includes the following information: The URI location of the configuration data. The Identity and Access Management (IAM) role that provides access to the configuration data. A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function. For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide. */ createConfigurationProfile(input: AWS.AppConfig.CreateConfigurationProfileRequest, options: SdkCallOptions): Promise; /** * Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time. */ createDeploymentStrategy(input: AWS.AppConfig.CreateDeploymentStrategyRequest, options: SdkCallOptions): Promise; /** * Creates an environment. For each application, you define one or more environments. An environment is a deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration. */ createEnvironment(input: AWS.AppConfig.CreateEnvironmentRequest, options: SdkCallOptions): Promise; /** * Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration. You can create your own extensions or use the Amazon Web Services-authored extensions provided by AppConfig. For most use-cases, to create your own extension, you must create an Lambda function to perform any computation and processing defined in the extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide. */ createExtension(input: AWS.AppConfig.CreateExtensionRequest, options: SdkCallOptions): Promise; /** * When you create an extension or configure an Amazon Web Services-authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services-authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide. */ createExtensionAssociation(input: AWS.AppConfig.CreateExtensionAssociationRequest, options: SdkCallOptions): Promise; /** * Creates a new configuration in the AppConfig hosted configuration store. */ createHostedConfigurationVersion(input: AWS.AppConfig.CreateHostedConfigurationVersionRequest, options: SdkCallOptions): Promise; /** * Deletes an application. Deleting an application does not delete a configuration from a host. */ deleteApplication(input: AWS.AppConfig.DeleteApplicationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host. */ deleteConfigurationProfile(input: AWS.AppConfig.DeleteConfigurationProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host. */ deleteDeploymentStrategy(input: AWS.AppConfig.DeleteDeploymentStrategyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an environment. Deleting an environment does not delete a configuration from a host. */ deleteEnvironment(input: AWS.AppConfig.DeleteEnvironmentRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension. */ deleteExtension(input: AWS.AppConfig.DeleteExtensionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an extension association. This action doesn't delete extensions defined in the association. */ deleteExtensionAssociation(input: AWS.AppConfig.DeleteExtensionAssociationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a version of a configuration from the AppConfig hosted configuration store. */ deleteHostedConfigurationVersion(input: AWS.AppConfig.DeleteHostedConfigurationVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves information about an application. */ getApplication(input: AWS.AppConfig.GetApplicationRequest, options: SdkCallOptions): Promise; /** * Retrieves the latest deployed configuration. Note the following important information. This API action has been deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead. GetConfiguration is a priced call. For more information, see Pricing. AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration. To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration. */ getConfiguration(input: AWS.AppConfig.GetConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a configuration profile. */ getConfigurationProfile(input: AWS.AppConfig.GetConfigurationProfileRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a configuration deployment. */ getDeployment(input: AWS.AppConfig.GetDeploymentRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time. */ getDeploymentStrategy(input: AWS.AppConfig.GetDeploymentStrategyRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an environment. An environment is a deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration. */ getEnvironment(input: AWS.AppConfig.GetEnvironmentRequest, options: SdkCallOptions): Promise; /** * Returns information about an AppConfig extension. */ getExtension(input: AWS.AppConfig.GetExtensionRequest, options: SdkCallOptions): Promise; /** * Returns information about an AppConfig extension association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide. */ getExtensionAssociation(input: AWS.AppConfig.GetExtensionAssociationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a specific configuration version. */ getHostedConfigurationVersion(input: AWS.AppConfig.GetHostedConfigurationVersionRequest, options: SdkCallOptions): Promise; /** * Lists all applications in your Amazon Web Services account. */ listApplications(input: AWS.AppConfig.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Lists the configuration profiles for an application. */ listConfigurationProfiles(input: AWS.AppConfig.ListConfigurationProfilesRequest, options: SdkCallOptions): Promise; /** * Lists deployment strategies. */ listDeploymentStrategies(input: AWS.AppConfig.ListDeploymentStrategiesRequest, options: SdkCallOptions): Promise; /** * Lists the deployments for an environment in descending deployment number order. */ listDeployments(input: AWS.AppConfig.ListDeploymentsRequest, options: SdkCallOptions): Promise; /** * Lists the environments for an application. */ listEnvironments(input: AWS.AppConfig.ListEnvironmentsRequest, options: SdkCallOptions): Promise; /** * Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide. */ listExtensionAssociations(input: AWS.AppConfig.ListExtensionAssociationsRequest, options: SdkCallOptions): Promise; /** * Lists all custom and Amazon Web Services-authored AppConfig extensions in the account. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide. */ listExtensions(input: AWS.AppConfig.ListExtensionsRequest, options: SdkCallOptions): Promise; /** * Lists configurations stored in the AppConfig hosted configuration store by version. */ listHostedConfigurationVersions(input: AWS.AppConfig.ListHostedConfigurationVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of key-value tags assigned to the resource. */ listTagsForResource(input: AWS.AppConfig.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts a deployment. */ startDeployment(input: AWS.AppConfig.StartDeploymentRequest, options: SdkCallOptions): Promise; /** * Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK. */ stopDeployment(input: AWS.AppConfig.StopDeploymentRequest, options: SdkCallOptions): Promise; /** * Assigns metadata to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource. */ tagResource(input: AWS.AppConfig.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a tag key and value from an AppConfig resource. */ untagResource(input: AWS.AppConfig.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an application. */ updateApplication(input: AWS.AppConfig.UpdateApplicationRequest, options: SdkCallOptions): Promise; /** * Updates a configuration profile. */ updateConfigurationProfile(input: AWS.AppConfig.UpdateConfigurationProfileRequest, options: SdkCallOptions): Promise; /** * Updates a deployment strategy. */ updateDeploymentStrategy(input: AWS.AppConfig.UpdateDeploymentStrategyRequest, options: SdkCallOptions): Promise; /** * Updates an environment. */ updateEnvironment(input: AWS.AppConfig.UpdateEnvironmentRequest, options: SdkCallOptions): Promise; /** * Updates an AppConfig extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide. */ updateExtension(input: AWS.AppConfig.UpdateExtensionRequest, options: SdkCallOptions): Promise; /** * Updates an association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide. */ updateExtensionAssociation(input: AWS.AppConfig.UpdateExtensionAssociationRequest, options: SdkCallOptions): Promise; /** * Uses the validators in a configuration profile to validate a configuration. */ validateConfiguration(input: AWS.AppConfig.ValidateConfigurationRequest, options: SdkCallOptions): Promise<{}>; } export interface AppConfigData { /** * 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 Receiving 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(input: AWS.AppConfigData.GetLatestConfigurationRequest, options: SdkCallOptions): Promise; /** * 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 Receiving the configuration in the AppConfig User Guide. */ startConfigurationSession(input: AWS.AppConfigData.StartConfigurationSessionRequest, options: SdkCallOptions): Promise; } export interface Appflow { /** * Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector. */ createConnectorProfile(input: AWS.Appflow.CreateConnectorProfileRequest, options: SdkCallOptions): Promise; /** * Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once. */ createFlow(input: AWS.Appflow.CreateFlowRequest, options: SdkCallOptions): Promise; /** * Enables you to delete an existing connector profile. */ deleteConnectorProfile(input: AWS.Appflow.DeleteConnectorProfileRequest, options: SdkCallOptions): Promise; /** * Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time. */ deleteFlow(input: AWS.Appflow.DeleteFlowRequest, options: SdkCallOptions): Promise; /** * Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors. */ describeConnector(input: AWS.Appflow.DescribeConnectorRequest, options: SdkCallOptions): Promise; /** * Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity. */ describeConnectorEntity(input: AWS.Appflow.DescribeConnectorEntityRequest, options: SdkCallOptions): Promise; /** * Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result. If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list. */ describeConnectorProfiles(input: AWS.Appflow.DescribeConnectorProfilesRequest, options: SdkCallOptions): Promise; /** * Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page. */ describeConnectors(input: AWS.Appflow.DescribeConnectorsRequest, options: SdkCallOptions): Promise; /** * Provides a description of the specified flow. */ describeFlow(input: AWS.Appflow.DescribeFlowRequest, options: SdkCallOptions): Promise; /** * Fetches the execution history of the flow. */ describeFlowExecutionRecords(input: AWS.Appflow.DescribeFlowExecutionRecordsRequest, options: SdkCallOptions): Promise; /** * Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity. */ listConnectorEntities(input: AWS.Appflow.ListConnectorEntitiesRequest, options: SdkCallOptions): Promise; /** * Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the Amazon Web Services authored connectors. */ listConnectors(input: AWS.Appflow.ListConnectorsRequest, options: SdkCallOptions): Promise; /** * Lists all of the flows associated with your account. */ listFlows(input: AWS.Appflow.ListFlowsRequest, options: SdkCallOptions): Promise; /** * Retrieves the tags that are associated with a specified flow. */ listTagsForResource(input: AWS.Appflow.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Registers a new connector with your Amazon Web Services account. Before you can register the connector, you must deploy lambda in your account. */ registerConnector(input: AWS.Appflow.RegisterConnectorRequest, options: SdkCallOptions): Promise; /** * Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow. */ startFlow(input: AWS.Appflow.StartFlowRequest, options: SdkCallOptions): Promise; /** * Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow. */ stopFlow(input: AWS.Appflow.StopFlowRequest, options: SdkCallOptions): Promise; /** * Applies a tag to the specified flow. */ tagResource(input: AWS.Appflow.TagResourceRequest, options: SdkCallOptions): Promise; /** * Unregisters the custom connector registered in your account that matches the connectorLabel provided in the request. */ unregisterConnector(input: AWS.Appflow.UnregisterConnectorRequest, options: SdkCallOptions): Promise; /** * Removes a tag from the specified flow. */ untagResource(input: AWS.Appflow.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a given connector profile associated with your account. */ updateConnectorProfile(input: AWS.Appflow.UpdateConnectorProfileRequest, options: SdkCallOptions): Promise; /** * Updates an existing flow. */ updateFlow(input: AWS.Appflow.UpdateFlowRequest, options: SdkCallOptions): Promise; } export interface AppIntegrations { /** * Creates and persists a DataIntegration resource. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. */ createDataIntegration(input: AWS.AppIntegrations.CreateDataIntegrationRequest, options: SdkCallOptions): Promise; /** * Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane. */ createEventIntegration(input: AWS.AppIntegrations.CreateEventIntegrationRequest, options: SdkCallOptions): Promise; /** * Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. */ deleteDataIntegration(input: AWS.AppIntegrations.DeleteDataIntegrationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected. */ deleteEventIntegration(input: AWS.AppIntegrations.DeleteEventIntegrationRequest, options: SdkCallOptions): Promise; /** * Returns information about the DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. */ getDataIntegration(input: AWS.AppIntegrations.GetDataIntegrationRequest, options: SdkCallOptions): Promise; /** * Returns information about the event integration. */ getEventIntegration(input: AWS.AppIntegrations.GetEventIntegrationRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of DataIntegration associations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. */ listDataIntegrationAssociations(input: AWS.AppIntegrations.ListDataIntegrationAssociationsRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of DataIntegrations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. */ listDataIntegrations(input: AWS.AppIntegrations.ListDataIntegrationsRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of event integration associations in the account. */ listEventIntegrationAssociations(input: AWS.AppIntegrations.ListEventIntegrationAssociationsRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of event integrations in the account. */ listEventIntegrations(input: AWS.AppIntegrations.ListEventIntegrationsRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.AppIntegrations.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified resource. */ tagResource(input: AWS.AppIntegrations.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified resource. */ untagResource(input: AWS.AppIntegrations.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the description of a DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. */ updateDataIntegration(input: AWS.AppIntegrations.UpdateDataIntegrationRequest, options: SdkCallOptions): Promise; /** * Updates the description of an event integration. */ updateEventIntegration(input: AWS.AppIntegrations.UpdateEventIntegrationRequest, options: SdkCallOptions): Promise; } export interface ApplicationAutoScaling { /** * 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(input: AWS.ApplicationAutoScaling.DeleteScalingPolicyRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.ApplicationAutoScaling.DeleteScheduledActionRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.ApplicationAutoScaling.DeregisterScalableTargetRequest, options: SdkCallOptions): Promise; /** * Gets information about the scalable targets in the specified namespace. You can filter the results using ResourceIds and ScalableDimension. */ describeScalableTargets(input: AWS.ApplicationAutoScaling.DescribeScalableTargetsRequest, options: SdkCallOptions): Promise; /** * 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. */ describeScalingActivities(input: AWS.ApplicationAutoScaling.DescribeScalingActivitiesRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.ApplicationAutoScaling.DescribeScalingPoliciesRequest, options: SdkCallOptions): Promise; /** * 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 and Managing scheduled scaling in the Application Auto Scaling User Guide. */ describeScheduledActions(input: AWS.ApplicationAutoScaling.DescribeScheduledActionsRequest, options: SdkCallOptions): Promise; /** * 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 execute scaling policies. Any scaling policies that were specified for the scalable target are deleted. */ putScalingPolicy(input: AWS.ApplicationAutoScaling.PutScalingPolicyRequest, options: SdkCallOptions): Promise; /** * 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 start and end times are specified 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(input: AWS.ApplicationAutoScaling.PutScheduledActionRequest, options: SdkCallOptions): Promise; /** * Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace. When you register a new scalable target, you must specify values for minimum and maximum capacity. Current capacity will be adjusted within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this 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 to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it is 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(input: AWS.ApplicationAutoScaling.RegisterScalableTargetRequest, options: SdkCallOptions): Promise; } export interface ApplicationCostProfiler { /** * Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated. */ deleteReportDefinition(input: AWS.ApplicationCostProfiler.DeleteReportDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves the definition of a report already configured in AWS Application Cost Profiler. */ getReportDefinition(input: AWS.ApplicationCostProfiler.GetReportDefinitionRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.ApplicationCostProfiler.ImportApplicationUsageRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all reports and their configurations for your AWS account. The maximum number of reports is one. */ listReportDefinitions(input: AWS.ApplicationCostProfiler.ListReportDefinitionsRequest, options: SdkCallOptions): Promise; /** * Creates the report definition for a report in Application Cost Profiler. */ putReportDefinition(input: AWS.ApplicationCostProfiler.PutReportDefinitionRequest, options: SdkCallOptions): Promise; /** * Updates existing report in AWS Application Cost Profiler. */ updateReportDefinition(input: AWS.ApplicationCostProfiler.UpdateReportDefinitionRequest, options: SdkCallOptions): Promise; } export interface ApplicationInsights { /** * Adds an application that is created from a resource group. */ createApplication(input: AWS.ApplicationInsights.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Creates a custom component by grouping similar standalone instances to monitor. */ createComponent(input: AWS.ApplicationInsights.CreateComponentRequest, options: SdkCallOptions): Promise; /** * Adds an log pattern to a LogPatternSet. */ createLogPattern(input: AWS.ApplicationInsights.CreateLogPatternRequest, options: SdkCallOptions): Promise; /** * Removes the specified application from monitoring. Does not delete the application. */ deleteApplication(input: AWS.ApplicationInsights.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status. */ deleteComponent(input: AWS.ApplicationInsights.DeleteComponentRequest, options: SdkCallOptions): Promise; /** * Removes the specified log pattern from a LogPatternSet. */ deleteLogPattern(input: AWS.ApplicationInsights.DeleteLogPatternRequest, options: SdkCallOptions): Promise; /** * Describes the application. */ describeApplication(input: AWS.ApplicationInsights.DescribeApplicationRequest, options: SdkCallOptions): Promise; /** * Describes a component and lists the resources that are grouped together in a component. */ describeComponent(input: AWS.ApplicationInsights.DescribeComponentRequest, options: SdkCallOptions): Promise; /** * Describes the monitoring configuration of the component. */ describeComponentConfiguration(input: AWS.ApplicationInsights.DescribeComponentConfigurationRequest, options: SdkCallOptions): Promise; /** * Describes the recommended monitoring configuration of the component. */ describeComponentConfigurationRecommendation(input: AWS.ApplicationInsights.DescribeComponentConfigurationRecommendationRequest, options: SdkCallOptions): Promise; /** * Describe a specific log pattern from a LogPatternSet. */ describeLogPattern(input: AWS.ApplicationInsights.DescribeLogPatternRequest, options: SdkCallOptions): Promise; /** * Describes an anomaly or error with the application. */ describeObservation(input: AWS.ApplicationInsights.DescribeObservationRequest, options: SdkCallOptions): Promise; /** * Describes an application problem. */ describeProblem(input: AWS.ApplicationInsights.DescribeProblemRequest, options: SdkCallOptions): Promise; /** * Describes the anomalies or errors associated with the problem. */ describeProblemObservations(input: AWS.ApplicationInsights.DescribeProblemObservationsRequest, options: SdkCallOptions): Promise; /** * Lists the IDs of the applications that you are monitoring. */ listApplications(input: AWS.ApplicationInsights.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Lists the auto-grouped, standalone, and custom components of the application. */ listComponents(input: AWS.ApplicationInsights.ListComponentsRequest, options: SdkCallOptions): Promise; /** * Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are: INFO: creating a new alarm or updating an alarm threshold. WARN: alarm not created due to insufficient data points used to predict thresholds. ERROR: alarm not created due to permission errors or exceeding quotas. */ listConfigurationHistory(input: AWS.ApplicationInsights.ListConfigurationHistoryRequest, options: SdkCallOptions): Promise; /** * Lists the log pattern sets in the specific application. */ listLogPatternSets(input: AWS.ApplicationInsights.ListLogPatternSetsRequest, options: SdkCallOptions): Promise; /** * Lists the log patterns in the specific log LogPatternSet. */ listLogPatterns(input: AWS.ApplicationInsights.ListLogPatternsRequest, options: SdkCallOptions): Promise; /** * Lists the problems with your application. */ listProblems(input: AWS.ApplicationInsights.ListProblemsRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. */ listTagsForResource(input: AWS.ApplicationInsights.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. */ tagResource(input: AWS.ApplicationInsights.TagResourceRequest, options: SdkCallOptions): Promise; /** * Remove one or more tags (keys and values) from a specified application. */ untagResource(input: AWS.ApplicationInsights.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the application. */ updateApplication(input: AWS.ApplicationInsights.UpdateApplicationRequest, options: SdkCallOptions): Promise; /** * Updates the custom component name and/or the list of resources that make up the component. */ updateComponent(input: AWS.ApplicationInsights.UpdateComponentRequest, options: SdkCallOptions): Promise; /** * Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation. */ updateComponentConfiguration(input: AWS.ApplicationInsights.UpdateComponentConfigurationRequest, options: SdkCallOptions): Promise; /** * Adds a log pattern to a LogPatternSet. */ updateLogPattern(input: AWS.ApplicationInsights.UpdateLogPatternRequest, options: SdkCallOptions): Promise; } export interface AppMesh { /** * Creates a gateway route. A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service. For more information about gateway routes, see Gateway routes. */ createGatewayRoute(input: AWS.AppMesh.CreateGatewayRouteInput, options: SdkCallOptions): Promise; /** * Creates a service mesh. A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh. For more information about service meshes, see Service meshes. */ createMesh(input: AWS.AppMesh.CreateMeshInput, options: SdkCallOptions): Promise; /** * Creates a route that is associated with a virtual router. You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes. For more information about routes, see Routes. */ createRoute(input: AWS.AppMesh.CreateRouteInput, options: SdkCallOptions): Promise; /** * Creates a virtual gateway. A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself. For more information about virtual gateways, see Virtual gateways. */ createVirtualGateway(input: AWS.AppMesh.CreateVirtualGatewayInput, options: SdkCallOptions): Promise; /** * Creates a virtual node within a service mesh. A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS). You define a listener for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is specified as a backend. The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value to the full ARN; for example, arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp) as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters. By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name. For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0 or later of the Envoy image when setting these variables. For more information aboutApp Mesh Envoy variables, see Envoy image in the App Mesh User Guide. */ createVirtualNode(input: AWS.AppMesh.CreateVirtualNodeInput, options: SdkCallOptions): Promise; /** * Creates a virtual router within a service mesh. Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes. For more information about virtual routers, see Virtual routers. */ createVirtualRouter(input: AWS.AppMesh.CreateVirtualRouterInput, options: SdkCallOptions): Promise; /** * Creates a virtual service within a service mesh. A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service. For more information about virtual services, see Virtual services. */ createVirtualService(input: AWS.AppMesh.CreateVirtualServiceInput, options: SdkCallOptions): Promise; /** * Deletes an existing gateway route. */ deleteGatewayRoute(input: AWS.AppMesh.DeleteGatewayRouteInput, options: SdkCallOptions): Promise; /** * Deletes an existing service mesh. You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself. */ deleteMesh(input: AWS.AppMesh.DeleteMeshInput, options: SdkCallOptions): Promise; /** * Deletes an existing route. */ deleteRoute(input: AWS.AppMesh.DeleteRouteInput, options: SdkCallOptions): Promise; /** * Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it. */ deleteVirtualGateway(input: AWS.AppMesh.DeleteVirtualGatewayInput, options: SdkCallOptions): Promise; /** * Deletes an existing virtual node. You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself. */ deleteVirtualNode(input: AWS.AppMesh.DeleteVirtualNodeInput, options: SdkCallOptions): Promise; /** * Deletes an existing virtual router. You must delete any routes associated with the virtual router before you can delete the router itself. */ deleteVirtualRouter(input: AWS.AppMesh.DeleteVirtualRouterInput, options: SdkCallOptions): Promise; /** * Deletes an existing virtual service. */ deleteVirtualService(input: AWS.AppMesh.DeleteVirtualServiceInput, options: SdkCallOptions): Promise; /** * Describes an existing gateway route. */ describeGatewayRoute(input: AWS.AppMesh.DescribeGatewayRouteInput, options: SdkCallOptions): Promise; /** * Describes an existing service mesh. */ describeMesh(input: AWS.AppMesh.DescribeMeshInput, options: SdkCallOptions): Promise; /** * Describes an existing route. */ describeRoute(input: AWS.AppMesh.DescribeRouteInput, options: SdkCallOptions): Promise; /** * Describes an existing virtual gateway. */ describeVirtualGateway(input: AWS.AppMesh.DescribeVirtualGatewayInput, options: SdkCallOptions): Promise; /** * Describes an existing virtual node. */ describeVirtualNode(input: AWS.AppMesh.DescribeVirtualNodeInput, options: SdkCallOptions): Promise; /** * Describes an existing virtual router. */ describeVirtualRouter(input: AWS.AppMesh.DescribeVirtualRouterInput, options: SdkCallOptions): Promise; /** * Describes an existing virtual service. */ describeVirtualService(input: AWS.AppMesh.DescribeVirtualServiceInput, options: SdkCallOptions): Promise; /** * Returns a list of existing gateway routes that are associated to a virtual gateway. */ listGatewayRoutes(input: AWS.AppMesh.ListGatewayRoutesInput, options: SdkCallOptions): Promise; /** * Returns a list of existing service meshes. */ listMeshes(input: AWS.AppMesh.ListMeshesInput, options: SdkCallOptions): Promise; /** * Returns a list of existing routes in a service mesh. */ listRoutes(input: AWS.AppMesh.ListRoutesInput, options: SdkCallOptions): Promise; /** * List the tags for an App Mesh resource. */ listTagsForResource(input: AWS.AppMesh.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Returns a list of existing virtual gateways in a service mesh. */ listVirtualGateways(input: AWS.AppMesh.ListVirtualGatewaysInput, options: SdkCallOptions): Promise; /** * Returns a list of existing virtual nodes. */ listVirtualNodes(input: AWS.AppMesh.ListVirtualNodesInput, options: SdkCallOptions): Promise; /** * Returns a list of existing virtual routers in a service mesh. */ listVirtualRouters(input: AWS.AppMesh.ListVirtualRoutersInput, options: SdkCallOptions): Promise; /** * Returns a list of existing virtual services in a service mesh. */ listVirtualServices(input: AWS.AppMesh.ListVirtualServicesInput, options: SdkCallOptions): Promise; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. */ tagResource(input: AWS.AppMesh.TagResourceInput, options: SdkCallOptions): Promise; /** * Deletes specified tags from a resource. */ untagResource(input: AWS.AppMesh.UntagResourceInput, options: SdkCallOptions): Promise; /** * Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh. */ updateGatewayRoute(input: AWS.AppMesh.UpdateGatewayRouteInput, options: SdkCallOptions): Promise; /** * Updates an existing service mesh. */ updateMesh(input: AWS.AppMesh.UpdateMeshInput, options: SdkCallOptions): Promise; /** * Updates an existing route for a specified service mesh and virtual router. */ updateRoute(input: AWS.AppMesh.UpdateRouteInput, options: SdkCallOptions): Promise; /** * Updates an existing virtual gateway in a specified service mesh. */ updateVirtualGateway(input: AWS.AppMesh.UpdateVirtualGatewayInput, options: SdkCallOptions): Promise; /** * Updates an existing virtual node in a specified service mesh. */ updateVirtualNode(input: AWS.AppMesh.UpdateVirtualNodeInput, options: SdkCallOptions): Promise; /** * Updates an existing virtual router in a specified service mesh. */ updateVirtualRouter(input: AWS.AppMesh.UpdateVirtualRouterInput, options: SdkCallOptions): Promise; /** * Updates an existing virtual service in a specified service mesh. */ updateVirtualService(input: AWS.AppMesh.UpdateVirtualServiceInput, options: SdkCallOptions): Promise; } export interface AppRunner { /** * Associate your own domain name with the App Runner subdomain URL of your App Runner service. After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM). */ associateCustomDomain(input: AWS.AppRunner.AssociateCustomDomainRequest, options: SdkCallOptions): Promise; /** * Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require non-default auto scaling settings. You can share an auto scaling configuration across multiple services. Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName. The call returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling configuration resource, the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific revision. Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost. Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand. */ createAutoScalingConfiguration(input: AWS.AppRunner.CreateAutoScalingConfigurationRequest, options: SdkCallOptions): Promise; /** * Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services. A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection. */ createConnection(input: AWS.AppRunner.CreateConnectionRequest, options: SdkCallOptions): Promise; /** * Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services. Create multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName. The call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision. The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional parameters that describe the configuration of these features (currently one parameter, TraceConfiguration). If you don't specify a feature parameter, App Runner doesn't enable the feature. */ createObservabilityConfiguration(input: AWS.AppRunner.CreateObservabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Create an App Runner service. After the service is created, the action also automatically starts a deployment. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress. */ createService(input: AWS.AppRunner.CreateServiceRequest, options: SdkCallOptions): Promise; /** * Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC). */ createVpcConnector(input: AWS.AppRunner.CreateVpcConnectorRequest, options: SdkCallOptions): Promise; /** * Delete an App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services. */ deleteAutoScalingConfiguration(input: AWS.AppRunner.DeleteAutoScalingConfigurationRequest, options: SdkCallOptions): Promise; /** * Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails. */ deleteConnection(input: AWS.AppRunner.DeleteConnectionRequest, options: SdkCallOptions): Promise; /** * Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services. */ deleteObservabilityConfiguration(input: AWS.AppRunner.DeleteObservabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Delete an App Runner service. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress. */ deleteService(input: AWS.AppRunner.DeleteServiceRequest, options: SdkCallOptions): Promise; /** * Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services. */ deleteVpcConnector(input: AWS.AppRunner.DeleteVpcConnectorRequest, options: SdkCallOptions): Promise; /** * Return a full description of an App Runner automatic scaling configuration resource. */ describeAutoScalingConfiguration(input: AWS.AppRunner.DescribeAutoScalingConfigurationRequest, options: SdkCallOptions): Promise; /** * Return a description of custom domain names that are associated with an App Runner service. */ describeCustomDomains(input: AWS.AppRunner.DescribeCustomDomainsRequest, options: SdkCallOptions): Promise; /** * Return a full description of an App Runner observability configuration resource. */ describeObservabilityConfiguration(input: AWS.AppRunner.DescribeObservabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Return a full description of an App Runner service. */ describeService(input: AWS.AppRunner.DescribeServiceRequest, options: SdkCallOptions): Promise; /** * Return a description of an App Runner VPC connector resource. */ describeVpcConnector(input: AWS.AppRunner.DescribeVpcConnectorRequest, options: SdkCallOptions): Promise; /** * Disassociate a custom domain name from an App Runner service. Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service. */ disassociateCustomDomain(input: AWS.AppRunner.DisassociateCustomDomainRequest, options: SdkCallOptions): Promise; /** * Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name. To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListAutoScalingConfigurations. */ listAutoScalingConfigurations(input: AWS.AppRunner.ListAutoScalingConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of App Runner connections that are associated with your Amazon Web Services account. */ listConnections(input: AWS.AppRunner.ListConnectionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name. To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListObservabilityConfigurations. */ listObservabilityConfigurations(input: AWS.AppRunner.ListObservabilityConfigurationsRequest, options: SdkCallOptions): Promise; /** * Return a list of operations that occurred on an App Runner service. The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation. */ listOperations(input: AWS.AppRunner.ListOperationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of running App Runner services in your Amazon Web Services account. */ listServices(input: AWS.AppRunner.ListServicesRequest, options: SdkCallOptions): Promise; /** * List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs. */ listTagsForResource(input: AWS.AppRunner.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of App Runner VPC connectors in your Amazon Web Services account. */ listVpcConnectors(input: AWS.AppRunner.ListVpcConnectorsRequest, options: SdkCallOptions): Promise; /** * Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed). This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress. */ pauseService(input: AWS.AppRunner.PauseServiceRequest, options: SdkCallOptions): Promise; /** * Resume an active App Runner service. App Runner provisions compute capacity for the service. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress. */ resumeService(input: AWS.AppRunner.ResumeServiceRequest, options: SdkCallOptions): Promise; /** * Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service. For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress. */ startDeployment(input: AWS.AppRunner.StartDeploymentRequest, options: SdkCallOptions): Promise; /** * Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair. */ tagResource(input: AWS.AppRunner.TagResourceRequest, options: SdkCallOptions): Promise; /** * Remove tags from an App Runner resource. */ untagResource(input: AWS.AppRunner.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service. To update the tags applied to your service, use the separate actions TagResource and UntagResource. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress. */ updateService(input: AWS.AppRunner.UpdateServiceRequest, options: SdkCallOptions): Promise; } export interface AppStream { /** * Associates the specified application with the specified fleet. This is only supported for Elastic fleets. */ associateApplicationFleet(input: AWS.AppStream.AssociateApplicationFleetRequest, options: SdkCallOptions): Promise; /** * Associates an application to entitle. */ associateApplicationToEntitlement(input: AWS.AppStream.AssociateApplicationToEntitlementRequest, options: SdkCallOptions): Promise; /** * Associates the specified fleet with the specified stack. */ associateFleet(input: AWS.AppStream.AssociateFleetRequest, options: SdkCallOptions): Promise; /** * Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain. */ batchAssociateUserStack(input: AWS.AppStream.BatchAssociateUserStackRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified users from the specified stacks. */ batchDisassociateUserStack(input: AWS.AppStream.BatchDisassociateUserStackRequest, options: SdkCallOptions): Promise; /** * Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied. */ copyImage(input: AWS.AppStream.CopyImageRequest, options: SdkCallOptions): Promise; /** * Creates an app block. App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block. This is only supported for Elastic fleets. */ createAppBlock(input: AWS.AppStream.CreateAppBlockRequest, options: SdkCallOptions): Promise; /** * Creates an application. Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch. This is only supported for Elastic fleets. */ createApplication(input: AWS.AppStream.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains. */ createDirectoryConfig(input: AWS.AppStream.CreateDirectoryConfigRequest, options: SdkCallOptions): Promise; /** * Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework. */ createEntitlement(input: AWS.AppStream.CreateEntitlementRequest, options: SdkCallOptions): Promise; /** * Creates a fleet. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand. */ createFleet(input: AWS.AppStream.CreateFleetRequest, options: SdkCallOptions): Promise; /** * Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING. */ createImageBuilder(input: AWS.AppStream.CreateImageBuilderRequest, options: SdkCallOptions): Promise; /** * Creates a URL to start an image builder streaming session. */ createImageBuilderStreamingURL(input: AWS.AppStream.CreateImageBuilderStreamingURLRequest, options: SdkCallOptions): Promise; /** * Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. */ createStack(input: AWS.AppStream.CreateStackRequest, options: SdkCallOptions): Promise; /** * Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup. */ createStreamingURL(input: AWS.AppStream.CreateStreamingURLRequest, options: SdkCallOptions): Promise; /** * Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software. For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide. */ createUpdatedImage(input: AWS.AppStream.CreateUpdatedImageRequest, options: SdkCallOptions): Promise; /** * Creates a usage report subscription. Usage reports are generated daily. */ createUsageReportSubscription(input: AWS.AppStream.CreateUsageReportSubscriptionRequest, options: SdkCallOptions): Promise; /** * Creates a new user in the user pool. */ createUser(input: AWS.AppStream.CreateUserRequest, options: SdkCallOptions): Promise; /** * Deletes an app block. */ deleteAppBlock(input: AWS.AppStream.DeleteAppBlockRequest, options: SdkCallOptions): Promise; /** * Deletes an application. */ deleteApplication(input: AWS.AppStream.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain. */ deleteDirectoryConfig(input: AWS.AppStream.DeleteDirectoryConfigRequest, options: SdkCallOptions): Promise; /** * Deletes the specified entitlement. */ deleteEntitlement(input: AWS.AppStream.DeleteEntitlementRequest, options: SdkCallOptions): Promise; /** * Deletes the specified fleet. */ deleteFleet(input: AWS.AppStream.DeleteFleetRequest, options: SdkCallOptions): Promise; /** * Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image. */ deleteImage(input: AWS.AppStream.DeleteImageRequest, options: SdkCallOptions): Promise; /** * Deletes the specified image builder and releases the capacity. */ deleteImageBuilder(input: AWS.AppStream.DeleteImageBuilderRequest, options: SdkCallOptions): Promise; /** * Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image. */ deleteImagePermissions(input: AWS.AppStream.DeleteImagePermissionsRequest, options: SdkCallOptions): Promise; /** * Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released. */ deleteStack(input: AWS.AppStream.DeleteStackRequest, options: SdkCallOptions): Promise; /** * Disables usage report generation. */ deleteUsageReportSubscription(input: AWS.AppStream.DeleteUsageReportSubscriptionRequest, options: SdkCallOptions): Promise; /** * Deletes a user from the user pool. */ deleteUser(input: AWS.AppStream.DeleteUserRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more app blocks. */ describeAppBlocks(input: AWS.AppStream.DescribeAppBlocksRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified. */ describeApplicationFleetAssociations(input: AWS.AppStream.DescribeApplicationFleetAssociationsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more applications. */ describeApplications(input: AWS.AppStream.DescribeApplicationsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response. */ describeDirectoryConfigs(input: AWS.AppStream.DescribeDirectoryConfigsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one of more entitlements. */ describeEntitlements(input: AWS.AppStream.DescribeEntitlementsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described. */ describeFleets(input: AWS.AppStream.DescribeFleetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described. */ describeImageBuilders(input: AWS.AppStream.DescribeImageBuildersRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own. */ describeImagePermissions(input: AWS.AppStream.DescribeImagePermissionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described. */ describeImages(input: AWS.AppStream.DescribeImagesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL. */ describeSessions(input: AWS.AppStream.DescribeSessionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described. */ describeStacks(input: AWS.AppStream.DescribeStacksRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more usage report subscriptions. */ describeUsageReportSubscriptions(input: AWS.AppStream.DescribeUsageReportSubscriptionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user */ describeUserStackAssociations(input: AWS.AppStream.DescribeUserStackAssociationsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more specified users in the user pool. */ describeUsers(input: AWS.AppStream.DescribeUsersRequest, options: SdkCallOptions): Promise; /** * Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user. */ disableUser(input: AWS.AppStream.DisableUserRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified application from the fleet. */ disassociateApplicationFleet(input: AWS.AppStream.DisassociateApplicationFleetRequest, options: SdkCallOptions): Promise; /** * Deletes the specified application from the specified entitlement. */ disassociateApplicationFromEntitlement(input: AWS.AppStream.DisassociateApplicationFromEntitlementRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified fleet from the specified stack. */ disassociateFleet(input: AWS.AppStream.DisassociateFleetRequest, options: SdkCallOptions): Promise; /** * Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned. */ enableUser(input: AWS.AppStream.EnableUserRequest, options: SdkCallOptions): Promise; /** * Immediately stops the specified streaming session. */ expireSession(input: AWS.AppStream.ExpireSessionRequest, options: SdkCallOptions): Promise; /** * Retrieves the name of the fleet that is associated with the specified stack. */ listAssociatedFleets(input: AWS.AppStream.ListAssociatedFleetsRequest, options: SdkCallOptions): Promise; /** * Retrieves the name of the stack with which the specified fleet is associated. */ listAssociatedStacks(input: AWS.AppStream.ListAssociatedStacksRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of entitled applications. */ listEntitledApplications(input: AWS.AppStream.ListEntitledApplicationsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide. */ listTagsForResource(input: AWS.AppStream.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts the specified fleet. */ startFleet(input: AWS.AppStream.StartFleetRequest, options: SdkCallOptions): Promise; /** * Starts the specified image builder. */ startImageBuilder(input: AWS.AppStream.StartImageBuilderRequest, options: SdkCallOptions): Promise; /** * Stops the specified fleet. */ stopFleet(input: AWS.AppStream.StopFleetRequest, options: SdkCallOptions): Promise; /** * Stops the specified image builder. */ stopImageBuilder(input: AWS.AppStream.StopImageBuilderRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide. */ tagResource(input: AWS.AppStream.TagResourceRequest, options: SdkCallOptions): Promise; /** * Disassociates one or more specified tags from the specified AppStream 2.0 resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide. */ untagResource(input: AWS.AppStream.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified application. */ updateApplication(input: AWS.AppStream.UpdateApplicationRequest, options: SdkCallOptions): Promise; /** * Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains. */ updateDirectoryConfig(input: AWS.AppStream.UpdateDirectoryConfigRequest, options: SdkCallOptions): Promise; /** * Updates the specified entitlement. */ updateEntitlement(input: AWS.AppStream.UpdateEntitlementRequest, options: SdkCallOptions): Promise; /** * Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the following based on the fleet type: Always-On and On-Demand fleet types You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. Elastic fleet type You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes. If the fleet is in the STARTING or STOPPED state, you can't update it. */ updateFleet(input: AWS.AppStream.UpdateFleetRequest, options: SdkCallOptions): Promise; /** * Adds or updates permissions for the specified private image. */ updateImagePermissions(input: AWS.AppStream.UpdateImagePermissionsRequest, options: SdkCallOptions): Promise; /** * Updates the specified fields for the specified stack. */ updateStack(input: AWS.AppStream.UpdateStackRequest, options: SdkCallOptions): Promise; } export interface AppSync { /** * Maps an endpoint to your custom domain. */ associateApi(input: AWS.AppSync.AssociateApiRequest, options: SdkCallOptions): Promise; /** * Creates a cache for the GraphQL API. */ createApiCache(input: AWS.AppSync.CreateApiCacheRequest, options: SdkCallOptions): Promise; /** * Creates a unique key that you can distribute to clients who invoke your API. */ createApiKey(input: AWS.AppSync.CreateApiKeyRequest, options: SdkCallOptions): Promise; /** * Creates a DataSource object. */ createDataSource(input: AWS.AppSync.CreateDataSourceRequest, options: SdkCallOptions): Promise; /** * Creates a custom DomainName object. */ createDomainName(input: AWS.AppSync.CreateDomainNameRequest, options: SdkCallOptions): Promise; /** * Creates a Function object. A function is a reusable entity. You can use multiple functions to compose the resolver logic. */ createFunction(input: AWS.AppSync.CreateFunctionRequest, options: SdkCallOptions): Promise; /** * Creates a GraphqlApi object. */ createGraphqlApi(input: AWS.AppSync.CreateGraphqlApiRequest, options: SdkCallOptions): Promise; /** * Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL. */ createResolver(input: AWS.AppSync.CreateResolverRequest, options: SdkCallOptions): Promise; /** * Creates a Type object. */ createType(input: AWS.AppSync.CreateTypeRequest, options: SdkCallOptions): Promise; /** * Deletes an ApiCache object. */ deleteApiCache(input: AWS.AppSync.DeleteApiCacheRequest, options: SdkCallOptions): Promise; /** * Deletes an API key. */ deleteApiKey(input: AWS.AppSync.DeleteApiKeyRequest, options: SdkCallOptions): Promise; /** * Deletes a DataSource object. */ deleteDataSource(input: AWS.AppSync.DeleteDataSourceRequest, options: SdkCallOptions): Promise; /** * Deletes a custom DomainName object. */ deleteDomainName(input: AWS.AppSync.DeleteDomainNameRequest, options: SdkCallOptions): Promise; /** * Deletes a Function. */ deleteFunction(input: AWS.AppSync.DeleteFunctionRequest, options: SdkCallOptions): Promise; /** * Deletes a GraphqlApi object. */ deleteGraphqlApi(input: AWS.AppSync.DeleteGraphqlApiRequest, options: SdkCallOptions): Promise; /** * Deletes a Resolver object. */ deleteResolver(input: AWS.AppSync.DeleteResolverRequest, options: SdkCallOptions): Promise; /** * Deletes a Type object. */ deleteType(input: AWS.AppSync.DeleteTypeRequest, options: SdkCallOptions): Promise; /** * Removes an ApiAssociation object from a custom domain. */ disassociateApi(input: AWS.AppSync.DisassociateApiRequest, options: SdkCallOptions): Promise; /** * Evaluates a given template and returns the response. The mapping template can be a request or response template. Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type. Mapping templates are written in the Apache Velocity Template Language (VTL). */ evaluateMappingTemplate(input: AWS.AppSync.EvaluateMappingTemplateRequest, options: SdkCallOptions): Promise; /** * Flushes an ApiCache object. */ flushApiCache(input: AWS.AppSync.FlushApiCacheRequest, options: SdkCallOptions): Promise; /** * Retrieves an ApiAssociation object. */ getApiAssociation(input: AWS.AppSync.GetApiAssociationRequest, options: SdkCallOptions): Promise; /** * Retrieves an ApiCache object. */ getApiCache(input: AWS.AppSync.GetApiCacheRequest, options: SdkCallOptions): Promise; /** * Retrieves a DataSource object. */ getDataSource(input: AWS.AppSync.GetDataSourceRequest, options: SdkCallOptions): Promise; /** * Retrieves a custom DomainName object. */ getDomainName(input: AWS.AppSync.GetDomainNameRequest, options: SdkCallOptions): Promise; /** * Get a Function. */ getFunction(input: AWS.AppSync.GetFunctionRequest, options: SdkCallOptions): Promise; /** * Retrieves a GraphqlApi object. */ getGraphqlApi(input: AWS.AppSync.GetGraphqlApiRequest, options: SdkCallOptions): Promise; /** * Retrieves the introspection schema for a GraphQL API. */ getIntrospectionSchema(input: AWS.AppSync.GetIntrospectionSchemaRequest, options: SdkCallOptions): Promise; /** * Retrieves a Resolver object. */ getResolver(input: AWS.AppSync.GetResolverRequest, options: SdkCallOptions): Promise; /** * Retrieves the current status of a schema creation operation. */ getSchemaCreationStatus(input: AWS.AppSync.GetSchemaCreationStatusRequest, options: SdkCallOptions): Promise; /** * Retrieves a Type object. */ getType(input: AWS.AppSync.GetTypeRequest, options: SdkCallOptions): Promise; /** * Lists the API keys for a given API. API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted. */ listApiKeys(input: AWS.AppSync.ListApiKeysRequest, options: SdkCallOptions): Promise; /** * Lists the data sources for a given API. */ listDataSources(input: AWS.AppSync.ListDataSourcesRequest, options: SdkCallOptions): Promise; /** * Lists multiple custom domain names. */ listDomainNames(input: AWS.AppSync.ListDomainNamesRequest, options: SdkCallOptions): Promise; /** * List multiple functions. */ listFunctions(input: AWS.AppSync.ListFunctionsRequest, options: SdkCallOptions): Promise; /** * Lists your GraphQL APIs. */ listGraphqlApis(input: AWS.AppSync.ListGraphqlApisRequest, options: SdkCallOptions): Promise; /** * Lists the resolvers for a given API and type. */ listResolvers(input: AWS.AppSync.ListResolversRequest, options: SdkCallOptions): Promise; /** * List the resolvers that are associated with a specific function. */ listResolversByFunction(input: AWS.AppSync.ListResolversByFunctionRequest, options: SdkCallOptions): Promise; /** * Lists the tags for a resource. */ listTagsForResource(input: AWS.AppSync.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the types for a given API. */ listTypes(input: AWS.AppSync.ListTypesRequest, options: SdkCallOptions): Promise; /** * Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed. */ startSchemaCreation(input: AWS.AppSync.StartSchemaCreationRequest, options: SdkCallOptions): Promise; /** * Tags a resource with user-supplied tags. */ tagResource(input: AWS.AppSync.TagResourceRequest, options: SdkCallOptions): Promise; /** * Untags a resource. */ untagResource(input: AWS.AppSync.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the cache for the GraphQL API. */ updateApiCache(input: AWS.AppSync.UpdateApiCacheRequest, options: SdkCallOptions): Promise; /** * Updates an API key. You can update the key as long as it's not deleted. */ updateApiKey(input: AWS.AppSync.UpdateApiKeyRequest, options: SdkCallOptions): Promise; /** * Updates a DataSource object. */ updateDataSource(input: AWS.AppSync.UpdateDataSourceRequest, options: SdkCallOptions): Promise; /** * Updates a custom DomainName object. */ updateDomainName(input: AWS.AppSync.UpdateDomainNameRequest, options: SdkCallOptions): Promise; /** * Updates a Function object. */ updateFunction(input: AWS.AppSync.UpdateFunctionRequest, options: SdkCallOptions): Promise; /** * Updates a GraphqlApi object. */ updateGraphqlApi(input: AWS.AppSync.UpdateGraphqlApiRequest, options: SdkCallOptions): Promise; /** * Updates a Resolver object. */ updateResolver(input: AWS.AppSync.UpdateResolverRequest, options: SdkCallOptions): Promise; /** * Updates a Type object. */ updateType(input: AWS.AppSync.UpdateTypeRequest, options: SdkCallOptions): Promise; } export interface Athena { /** * Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs. */ batchGetNamedQuery(input: AWS.Athena.BatchGetNamedQueryInput, options: SdkCallOptions): Promise; /** * Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames. */ batchGetPreparedStatement(input: AWS.Athena.BatchGetPreparedStatementInput, options: SdkCallOptions): Promise; /** * Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries. */ batchGetQueryExecution(input: AWS.Athena.BatchGetQueryExecutionInput, options: SdkCallOptions): Promise; /** * Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account. */ createDataCatalog(input: AWS.Athena.CreateDataCatalogInput, options: SdkCallOptions): Promise; /** * Creates a named query in the specified workgroup. Requires that you have access to the workgroup. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. */ createNamedQuery(input: AWS.Athena.CreateNamedQueryInput, options: SdkCallOptions): Promise; /** * Creates a prepared statement for use with SQL queries in Athena. */ createPreparedStatement(input: AWS.Athena.CreatePreparedStatementInput, options: SdkCallOptions): Promise; /** * Creates a workgroup with the specified name. */ createWorkGroup(input: AWS.Athena.CreateWorkGroupInput, options: SdkCallOptions): Promise; /** * Deletes a data catalog. */ deleteDataCatalog(input: AWS.Athena.DeleteDataCatalogInput, options: SdkCallOptions): Promise; /** * Deletes the named query if you have access to the workgroup in which the query was saved. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. */ deleteNamedQuery(input: AWS.Athena.DeleteNamedQueryInput, options: SdkCallOptions): Promise; /** * Deletes the prepared statement with the specified name from the specified workgroup. */ deletePreparedStatement(input: AWS.Athena.DeletePreparedStatementInput, options: SdkCallOptions): Promise; /** * Deletes the workgroup with the specified name. The primary workgroup cannot be deleted. */ deleteWorkGroup(input: AWS.Athena.DeleteWorkGroupInput, options: SdkCallOptions): Promise; /** * Returns the specified data catalog. */ getDataCatalog(input: AWS.Athena.GetDataCatalogInput, options: SdkCallOptions): Promise; /** * Returns a database object for the specified database and data catalog. */ getDatabase(input: AWS.Athena.GetDatabaseInput, options: SdkCallOptions): Promise; /** * Returns information about a single query. Requires that you have access to the workgroup in which the query was saved. */ getNamedQuery(input: AWS.Athena.GetNamedQueryInput, options: SdkCallOptions): Promise; /** * Retrieves the prepared statement with the specified name from the specified workgroup. */ getPreparedStatement(input: AWS.Athena.GetPreparedStatementInput, options: SdkCallOptions): Promise; /** * Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID. */ getQueryExecution(input: AWS.Athena.GetQueryExecutionInput, options: SdkCallOptions): Promise; /** * Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query. To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location. IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied. */ getQueryResults(input: AWS.Athena.GetQueryResultsInput, options: SdkCallOptions): Promise; /** * Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. The query execution runtime statistics is returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. */ getQueryRuntimeStatistics(input: AWS.Athena.GetQueryRuntimeStatisticsInput, options: SdkCallOptions): Promise; /** * Returns table metadata for the specified catalog, database, and table. */ getTableMetadata(input: AWS.Athena.GetTableMetadataInput, options: SdkCallOptions): Promise; /** * Returns information about the workgroup with the specified name. */ getWorkGroup(input: AWS.Athena.GetWorkGroupInput, options: SdkCallOptions): Promise; /** * Lists the data catalogs in the current Amazon Web Services account. */ listDataCatalogs(input: AWS.Athena.ListDataCatalogsInput, options: SdkCallOptions): Promise; /** * Lists the databases in the specified data catalog. */ listDatabases(input: AWS.Athena.ListDatabasesInput, options: SdkCallOptions): Promise; /** * Returns a list of engine versions that are available to choose from, including the Auto option. */ listEngineVersions(input: AWS.Athena.ListEngineVersionsInput, options: SdkCallOptions): Promise; /** * Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. */ listNamedQueries(input: AWS.Athena.ListNamedQueriesInput, options: SdkCallOptions): Promise; /** * Lists the prepared statements in the specified workgroup. */ listPreparedStatements(input: AWS.Athena.ListPreparedStatementsInput, options: SdkCallOptions): Promise; /** * Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. */ listQueryExecutions(input: AWS.Athena.ListQueryExecutionsInput, options: SdkCallOptions): Promise; /** * Lists the metadata for the tables in the specified data catalog database. */ listTableMetadata(input: AWS.Athena.ListTableMetadataInput, options: SdkCallOptions): Promise; /** * Lists the tags associated with an Athena workgroup or data catalog resource. */ listTagsForResource(input: AWS.Athena.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Lists available workgroups for the account. */ listWorkGroups(input: AWS.Athena.ListWorkGroupsInput, options: SdkCallOptions): Promise; /** * Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. */ startQueryExecution(input: AWS.Athena.StartQueryExecutionInput, options: SdkCallOptions): Promise; /** * Stops a query execution. Requires you to have access to the workgroup in which the query ran. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. */ stopQueryExecution(input: AWS.Athena.StopQueryExecutionInput, options: SdkCallOptions): Promise; /** * Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas. */ tagResource(input: AWS.Athena.TagResourceInput, options: SdkCallOptions): Promise; /** * Removes one or more tags from a data catalog or workgroup resource. */ untagResource(input: AWS.Athena.UntagResourceInput, options: SdkCallOptions): Promise; /** * Updates the data catalog that has the specified name. */ updateDataCatalog(input: AWS.Athena.UpdateDataCatalogInput, options: SdkCallOptions): Promise; /** * Updates a NamedQuery object. The database or workgroup cannot be updated. */ updateNamedQuery(input: AWS.Athena.UpdateNamedQueryInput, options: SdkCallOptions): Promise; /** * Updates a prepared statement. */ updatePreparedStatement(input: AWS.Athena.UpdatePreparedStatementInput, options: SdkCallOptions): Promise; /** * Updates the workgroup with the specified name. The workgroup's name cannot be changed. */ updateWorkGroup(input: AWS.Athena.UpdateWorkGroupInput, options: SdkCallOptions): Promise; } export interface AuditManager { /** * Associates an evidence folder to an assessment report in a Audit Manager assessment. */ associateAssessmentReportEvidenceFolder(input: AWS.AuditManager.AssociateAssessmentReportEvidenceFolderRequest, options: SdkCallOptions): Promise; /** * Associates a list of evidence to an assessment report in an Audit Manager assessment. */ batchAssociateAssessmentReportEvidence(input: AWS.AuditManager.BatchAssociateAssessmentReportEvidenceRequest, options: SdkCallOptions): Promise; /** * Creates a batch of delegations for an assessment in Audit Manager. */ batchCreateDelegationByAssessment(input: AWS.AuditManager.BatchCreateDelegationByAssessmentRequest, options: SdkCallOptions): Promise; /** * Deletes a batch of delegations for an assessment in Audit Manager. */ batchDeleteDelegationByAssessment(input: AWS.AuditManager.BatchDeleteDelegationByAssessmentRequest, options: SdkCallOptions): Promise; /** * Disassociates a list of evidence from an assessment report in Audit Manager. */ batchDisassociateAssessmentReportEvidence(input: AWS.AuditManager.BatchDisassociateAssessmentReportEvidenceRequest, options: SdkCallOptions): Promise; /** * Uploads one or more pieces of evidence to a control in an Audit Manager assessment. */ batchImportEvidenceToAssessmentControl(input: AWS.AuditManager.BatchImportEvidenceToAssessmentControlRequest, options: SdkCallOptions): Promise; /** * Creates an assessment in Audit Manager. */ createAssessment(input: AWS.AuditManager.CreateAssessmentRequest, options: SdkCallOptions): Promise; /** * Creates a custom framework in Audit Manager. */ createAssessmentFramework(input: AWS.AuditManager.CreateAssessmentFrameworkRequest, options: SdkCallOptions): Promise; /** * Creates an assessment report for the specified assessment. */ createAssessmentReport(input: AWS.AuditManager.CreateAssessmentReportRequest, options: SdkCallOptions): Promise; /** * Creates a new custom control in Audit Manager. */ createControl(input: AWS.AuditManager.CreateControlRequest, options: SdkCallOptions): Promise; /** * Deletes an assessment in Audit Manager. */ deleteAssessment(input: AWS.AuditManager.DeleteAssessmentRequest, options: SdkCallOptions): Promise; /** * Deletes a custom framework in Audit Manager. */ deleteAssessmentFramework(input: AWS.AuditManager.DeleteAssessmentFrameworkRequest, options: SdkCallOptions): Promise; /** * Deletes a share request for a custom framework in Audit Manager. */ deleteAssessmentFrameworkShare(input: AWS.AuditManager.DeleteAssessmentFrameworkShareRequest, options: SdkCallOptions): Promise; /** * Deletes an assessment report in Audit Manager. When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data: The specified assessment report that’s stored in your S3 bucket The associated metadata that’s stored in Audit Manager If Audit Manager can’t access the assessment report in your S3 bucket, the report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it proceeds to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself. This scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this, make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403 (Forbidden) or 404 (Not Found) error from Amazon S3, see List of Error Codes in the Amazon Simple Storage Service API Reference. */ deleteAssessmentReport(input: AWS.AuditManager.DeleteAssessmentReportRequest, options: SdkCallOptions): Promise; /** * Deletes a custom control in Audit Manager. */ deleteControl(input: AWS.AuditManager.DeleteControlRequest, options: SdkCallOptions): Promise; /** * Deregisters an account in Audit Manager. When you deregister your account from Audit Manager, your data isn’t deleted. If you want to delete your resource data, you must perform that task separately before you deregister your account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager. To delete your Audit Manager resource data, see the following instructions: DeleteAssessment (see also: Deleting an assessment in the Audit Manager User Guide) DeleteAssessmentFramework (see also: Deleting a custom framework in the Audit Manager User Guide) DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User Guide) DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager User Guide) DeleteControl (see also: Deleting a custom control in the Audit Manager User Guide) At this time, Audit Manager doesn't provide an option to delete evidence. All available delete operations are listed above. */ deregisterAccount(input: AWS.AuditManager.DeregisterAccountRequest, options: SdkCallOptions): Promise; /** * Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager. When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager will stop collecting and attaching evidence to that delegated administrator account moving forward. When you deregister a delegated administrator account for Audit Manager, the data for that account isn’t deleted. If you want to delete resource data for a delegated administrator account, you must perform that task separately before you deregister the account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager. To delete your Audit Manager resource data, see the following instructions: DeleteAssessment (see also: Deleting an assessment in the Audit Manager User Guide) DeleteAssessmentFramework (see also: Deleting a custom framework in the Audit Manager User Guide) DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User Guide) DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager User Guide) DeleteControl (see also: Deleting a custom control in the Audit Manager User Guide) At this time, Audit Manager doesn't provide an option to delete evidence. All available delete operations are listed above. */ deregisterOrganizationAdminAccount(input: AWS.AuditManager.DeregisterOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates an evidence folder from the specified assessment report in Audit Manager. */ disassociateAssessmentReportEvidenceFolder(input: AWS.AuditManager.DisassociateAssessmentReportEvidenceFolderRequest, options: SdkCallOptions): Promise; /** * Returns the registration status of an account in Audit Manager. */ getAccountStatus(input: AWS.AuditManager.GetAccountStatusRequest, options: SdkCallOptions): Promise; /** * Returns an assessment from Audit Manager. */ getAssessment(input: AWS.AuditManager.GetAssessmentRequest, options: SdkCallOptions): Promise; /** * Returns a framework from Audit Manager. */ getAssessmentFramework(input: AWS.AuditManager.GetAssessmentFrameworkRequest, options: SdkCallOptions): Promise; /** * Returns the URL of an assessment report in Audit Manager. */ getAssessmentReportUrl(input: AWS.AuditManager.GetAssessmentReportUrlRequest, options: SdkCallOptions): Promise; /** * Returns a list of changelogs from Audit Manager. */ getChangeLogs(input: AWS.AuditManager.GetChangeLogsRequest, options: SdkCallOptions): Promise; /** * Returns a control from Audit Manager. */ getControl(input: AWS.AuditManager.GetControlRequest, options: SdkCallOptions): Promise; /** * Returns a list of delegations from an audit owner to a delegate. */ getDelegations(input: AWS.AuditManager.GetDelegationsRequest, options: SdkCallOptions): Promise; /** * Returns evidence from Audit Manager. */ getEvidence(input: AWS.AuditManager.GetEvidenceRequest, options: SdkCallOptions): Promise; /** * Returns all evidence from a specified evidence folder in Audit Manager. */ getEvidenceByEvidenceFolder(input: AWS.AuditManager.GetEvidenceByEvidenceFolderRequest, options: SdkCallOptions): Promise; /** * Returns an evidence folder from the specified assessment in Audit Manager. */ getEvidenceFolder(input: AWS.AuditManager.GetEvidenceFolderRequest, options: SdkCallOptions): Promise; /** * Returns the evidence folders from a specified assessment in Audit Manager. */ getEvidenceFoldersByAssessment(input: AWS.AuditManager.GetEvidenceFoldersByAssessmentRequest, options: SdkCallOptions): Promise; /** * Returns a list of evidence folders that are associated with a specified control of an assessment in Audit Manager. */ getEvidenceFoldersByAssessmentControl(input: AWS.AuditManager.GetEvidenceFoldersByAssessmentControlRequest, options: SdkCallOptions): Promise; /** * Gets the latest analytics data for all your current active assessments. */ getInsights(input: AWS.AuditManager.GetInsightsRequest, options: SdkCallOptions): Promise; /** * Gets the latest analytics data for a specific active assessment. */ getInsightsByAssessment(input: AWS.AuditManager.GetInsightsByAssessmentRequest, options: SdkCallOptions): Promise; /** * Returns the name of the delegated Amazon Web Services administrator account for the organization. */ getOrganizationAdminAccount(input: AWS.AuditManager.GetOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Returns a list of the in-scope Amazon Web Services for the specified assessment. */ getServicesInScope(input: AWS.AuditManager.GetServicesInScopeRequest, options: SdkCallOptions): Promise; /** * Returns the settings for the specified Amazon Web Services account. */ getSettings(input: AWS.AuditManager.GetSettingsRequest, options: SdkCallOptions): Promise; /** * Lists the latest analytics data for controls within a specific control domain and a specific active assessment. Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control. */ listAssessmentControlInsightsByControlDomain(input: AWS.AuditManager.ListAssessmentControlInsightsByControlDomainRequest, options: SdkCallOptions): Promise; /** * Returns a list of sent or received share requests for custom frameworks in Audit Manager. */ listAssessmentFrameworkShareRequests(input: AWS.AuditManager.ListAssessmentFrameworkShareRequestsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the frameworks that are available in the Audit Manager framework library. */ listAssessmentFrameworks(input: AWS.AuditManager.ListAssessmentFrameworksRequest, options: SdkCallOptions): Promise; /** * Returns a list of assessment reports created in Audit Manager. */ listAssessmentReports(input: AWS.AuditManager.ListAssessmentReportsRequest, options: SdkCallOptions): Promise; /** * Returns a list of current and past assessments from Audit Manager. */ listAssessments(input: AWS.AuditManager.ListAssessmentsRequest, options: SdkCallOptions): Promise; /** * Lists the latest analytics data for control domains across all of your active assessments. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain. */ listControlDomainInsights(input: AWS.AuditManager.ListControlDomainInsightsRequest, options: SdkCallOptions): Promise; /** * Lists analytics data for control domains within a specified active assessment. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain. */ listControlDomainInsightsByAssessment(input: AWS.AuditManager.ListControlDomainInsightsByAssessmentRequest, options: SdkCallOptions): Promise; /** * Lists the latest analytics data for controls within a specific control domain across all active assessments. Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control. */ listControlInsightsByControlDomain(input: AWS.AuditManager.ListControlInsightsByControlDomainRequest, options: SdkCallOptions): Promise; /** * Returns a list of controls from Audit Manager. */ listControls(input: AWS.AuditManager.ListControlsRequest, options: SdkCallOptions): Promise; /** * Returns a list of keywords that are pre-mapped to the specified control data source. */ listKeywordsForDataSource(input: AWS.AuditManager.ListKeywordsForDataSourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of all Audit Manager notifications. */ listNotifications(input: AWS.AuditManager.ListNotificationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags for the specified resource in Audit Manager. */ listTagsForResource(input: AWS.AuditManager.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Enables Audit Manager for the specified Amazon Web Services account. */ registerAccount(input: AWS.AuditManager.RegisterAccountRequest, options: SdkCallOptions): Promise; /** * Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager. */ registerOrganizationAdminAccount(input: AWS.AuditManager.RegisterOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Creates a share request for a custom framework in Audit Manager. The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires. When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs: The sender revokes the share request. The recipient declines the share request. The recipient encounters an error and doesn't successfully accept the share request. The share request expires before the recipient responds to the request. When a sender resends a share request, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework. When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User Guide. */ startAssessmentFrameworkShare(input: AWS.AuditManager.StartAssessmentFrameworkShareRequest, options: SdkCallOptions): Promise; /** * Tags the specified resource in Audit Manager. */ tagResource(input: AWS.AuditManager.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from a resource in Audit Manager. */ untagResource(input: AWS.AuditManager.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Edits an Audit Manager assessment. */ updateAssessment(input: AWS.AuditManager.UpdateAssessmentRequest, options: SdkCallOptions): Promise; /** * Updates a control within an assessment in Audit Manager. */ updateAssessmentControl(input: AWS.AuditManager.UpdateAssessmentControlRequest, options: SdkCallOptions): Promise; /** * Updates the status of a control set in an Audit Manager assessment. */ updateAssessmentControlSetStatus(input: AWS.AuditManager.UpdateAssessmentControlSetStatusRequest, options: SdkCallOptions): Promise; /** * Updates a custom framework in Audit Manager. */ updateAssessmentFramework(input: AWS.AuditManager.UpdateAssessmentFrameworkRequest, options: SdkCallOptions): Promise; /** * Updates a share request for a custom framework in Audit Manager. */ updateAssessmentFrameworkShare(input: AWS.AuditManager.UpdateAssessmentFrameworkShareRequest, options: SdkCallOptions): Promise; /** * Updates the status of an assessment in Audit Manager. */ updateAssessmentStatus(input: AWS.AuditManager.UpdateAssessmentStatusRequest, options: SdkCallOptions): Promise; /** * Updates a custom control in Audit Manager. */ updateControl(input: AWS.AuditManager.UpdateControlRequest, options: SdkCallOptions): Promise; /** * Updates Audit Manager settings for the current user account. */ updateSettings(input: AWS.AuditManager.UpdateSettingsRequest, options: SdkCallOptions): Promise; /** * Validates the integrity of an assessment report in Audit Manager. */ validateAssessmentReportIntegrity(input: AWS.AuditManager.ValidateAssessmentReportIntegrityRequest, options: SdkCallOptions): Promise; } export interface AugmentedAIRuntime { /** * Deletes the specified human loop for a flow definition. If the human loop was deleted, this operation will return a ResourceNotFoundException. */ deleteHumanLoop(input: AWS.AugmentedAIRuntime.DeleteHumanLoopRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error. */ describeHumanLoop(input: AWS.AugmentedAIRuntime.DescribeHumanLoopRequest, options: SdkCallOptions): Promise; /** * Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included. */ listHumanLoops(input: AWS.AugmentedAIRuntime.ListHumanLoopsRequest, options: SdkCallOptions): Promise; /** * Starts a human loop, provided that at least one activation condition is met. */ startHumanLoop(input: AWS.AugmentedAIRuntime.StartHumanLoopRequest, options: SdkCallOptions): Promise; /** * Stops the specified human loop. */ stopHumanLoop(input: AWS.AugmentedAIRuntime.StopHumanLoopRequest, options: SdkCallOptions): Promise; } export interface AutoScaling { /** * Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups. For more information, see Attach EC2 instances to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ attachInstances(input: AWS.AutoScaling.AttachInstancesQuery, options: SdkCallOptions): Promise<{}>; /** * Attaches one or more target groups to the specified Auto Scaling group. This operation is used with the following load balancer types: Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS. Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP. Gateway Load Balancer - Operates at the network layer (layer 3). To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API. This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ attachLoadBalancerTargetGroups(input: AWS.AutoScaling.AttachLoadBalancerTargetGroupsType, options: SdkCallOptions): Promise; /** * To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead. Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers. To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API. This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ attachLoadBalancers(input: AWS.AutoScaling.AttachLoadBalancersType, options: SdkCallOptions): Promise; /** * Deletes one or more scheduled actions for the specified Auto Scaling group. */ batchDeleteScheduledAction(input: AWS.AutoScaling.BatchDeleteScheduledActionType, options: SdkCallOptions): Promise; /** * Creates or updates one or more scheduled scaling actions for an Auto Scaling group. */ batchPutScheduledUpdateGroupAction(input: AWS.AutoScaling.BatchPutScheduledUpdateGroupActionType, options: SdkCallOptions): Promise; /** * Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes. */ cancelInstanceRefresh(input: AWS.AutoScaling.CancelInstanceRefreshType, options: SdkCallOptions): Promise; /** * Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. */ completeLifecycleAction(input: AWS.AutoScaling.CompleteLifecycleActionType, options: SdkCallOptions): Promise; /** * We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide. Every Auto Scaling group has three size properties (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances. */ createAutoScalingGroup(input: AWS.AutoScaling.CreateAutoScalingGroupType, options: SdkCallOptions): Promise<{}>; /** * Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide. */ createLaunchConfiguration(input: AWS.AutoScaling.CreateLaunchConfigurationType, options: SdkCallOptions): Promise<{}>; /** * Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide. */ createOrUpdateTags(input: AWS.AutoScaling.CreateOrUpdateTagsType, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances. To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero. */ deleteAutoScalingGroup(input: AWS.AutoScaling.DeleteAutoScalingGroupType, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. */ deleteLaunchConfiguration(input: AWS.AutoScaling.LaunchConfigurationNameType, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances). */ deleteLifecycleHook(input: AWS.AutoScaling.DeleteLifecycleHookType, options: SdkCallOptions): Promise; /** * Deletes the specified notification. */ deleteNotificationConfiguration(input: AWS.AutoScaling.DeleteNotificationConfigurationType, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified scaling policy. Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide. */ deletePolicy(input: AWS.AutoScaling.DeletePolicyType, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified scheduled action. */ deleteScheduledAction(input: AWS.AutoScaling.DeleteScheduledActionType, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified tags. */ deleteTags(input: AWS.AutoScaling.DeleteTagsType, options: SdkCallOptions): Promise<{}>; /** * Deletes the warm pool for the specified Auto Scaling group. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. */ deleteWarmPool(input: AWS.AutoScaling.DeleteWarmPoolType, options: SdkCallOptions): Promise; /** * Gets information about the Auto Scaling groups in the account and Region. If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups. This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API. */ describeAutoScalingGroups(input: AWS.AutoScaling.AutoScalingGroupNamesType, options: SdkCallOptions): Promise; /** * Gets information about the Auto Scaling instances in the account and Region. */ describeAutoScalingInstances(input: AWS.AutoScaling.DescribeAutoScalingInstancesType, options: SdkCallOptions): Promise; /** * Gets information about the instance refreshes for the specified Auto Scaling group. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes. To help you determine the status of an instance refresh, this operation returns information about the instance refreshes you previously initiated, including their status, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. The following are the possible statuses: Pending - The request was created, but the operation has not started. InProgress - The operation is in progress. Successful - The operation completed successfully. Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities. Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started. Cancelled - The operation is cancelled. */ describeInstanceRefreshes(input: AWS.AutoScaling.DescribeInstanceRefreshesType, options: SdkCallOptions): Promise; /** * Gets information about the launch configurations in the account and Region. */ describeLaunchConfigurations(input: AWS.AutoScaling.LaunchConfigurationNamesType, options: SdkCallOptions): Promise; /** * Gets information about the lifecycle hooks for the specified Auto Scaling group. */ describeLifecycleHooks(input: AWS.AutoScaling.DescribeLifecycleHooksType, options: SdkCallOptions): Promise; /** * Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group. To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService state. Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary. For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ describeLoadBalancerTargetGroups(input: AWS.AutoScaling.DescribeLoadBalancerTargetGroupsRequest, options: SdkCallOptions): Promise; /** * Gets information about the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancer, use the DescribeLoadBalancerTargetGroups API instead. To determine the attachment status of the load balancer, use the State element in the response. When you attach a load balancer to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter the InService state. Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary. For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ describeLoadBalancers(input: AWS.AutoScaling.DescribeLoadBalancersRequest, options: SdkCallOptions): Promise; /** * Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups. */ describeNotificationConfigurations(input: AWS.AutoScaling.DescribeNotificationConfigurationsType, options: SdkCallOptions): Promise; /** * Gets information about the scaling policies in the account and Region. */ describePolicies(input: AWS.AutoScaling.DescribePoliciesType, options: SdkCallOptions): Promise; /** * Gets information about the scaling activities in the account and Region. When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. */ describeScalingActivities(input: AWS.AutoScaling.DescribeScalingActivitiesType, options: SdkCallOptions): Promise; /** * Gets information about the scheduled actions that haven't run or that have not reached their end time. To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API. */ describeScheduledActions(input: AWS.AutoScaling.DescribeScheduledActionsType, options: SdkCallOptions): Promise; /** * Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide. */ describeTags(input: AWS.AutoScaling.DescribeTagsType, options: SdkCallOptions): Promise; /** * Gets information about a warm pool and its instances. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. */ describeWarmPool(input: AWS.AutoScaling.DescribeWarmPoolType, options: SdkCallOptions): Promise; /** * Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach EC2 instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ detachInstances(input: AWS.AutoScaling.DetachInstancesQuery, options: SdkCallOptions): Promise; /** * Detaches one or more target groups from the specified Auto Scaling group. When you detach a target group, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running. */ detachLoadBalancerTargetGroups(input: AWS.AutoScaling.DetachLoadBalancerTargetGroupsType, options: SdkCallOptions): Promise; /** * Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancer, use the DetachLoadBalancerTargetGroups API instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running. */ detachLoadBalancers(input: AWS.AutoScaling.DetachLoadBalancersType, options: SdkCallOptions): Promise; /** * Disables group metrics collection for the specified Auto Scaling group. */ disableMetricsCollection(input: AWS.AutoScaling.DisableMetricsCollectionQuery, options: SdkCallOptions): Promise<{}>; /** * Enables group metrics collection for the specified Auto Scaling group. You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide. */ enableMetricsCollection(input: AWS.AutoScaling.EnableMetricsCollectionQuery, options: SdkCallOptions): Promise<{}>; /** * Moves the specified instances into the standby state. If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group. If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby. For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ enterStandby(input: AWS.AutoScaling.EnterStandbyQuery, options: SdkCallOptions): Promise; /** * Executes the specified policy. This can be useful for testing the design of your scaling policy. */ executePolicy(input: AWS.AutoScaling.ExecutePolicyType, options: SdkCallOptions): Promise<{}>; /** * Moves the specified instances out of the standby state. After you put the instances back in service, the desired capacity is incremented. For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ exitStandby(input: AWS.AutoScaling.ExitStandbyQuery, options: SdkCallOptions): Promise; /** * Retrieves the forecast data for a predictive scaling policy. Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast. A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts. For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. */ getPredictiveScalingForecast(input: AWS.AutoScaling.GetPredictiveScalingForecastType, options: SdkCallOptions): Promise; /** * Creates or updates a lifecycle hook for the specified Auto Scaling group. Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API. */ putLifecycleHook(input: AWS.AutoScaling.PutLifecycleHookType, options: SdkCallOptions): Promise; /** * Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Getting Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails. */ putNotificationConfiguration(input: AWS.AutoScaling.PutNotificationConfigurationType, options: SdkCallOptions): Promise<{}>; /** * Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used. For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide. For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API. */ putScalingPolicy(input: AWS.AutoScaling.PutScalingPolicyType, options: SdkCallOptions): Promise; /** * Creates or updates a scheduled scaling action for an Auto Scaling group. For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide. You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API. If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message. */ putScheduledUpdateGroupAction(input: AWS.AutoScaling.PutScheduledUpdateGroupActionType, options: SdkCallOptions): Promise<{}>; /** * Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances. You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API. */ putWarmPool(input: AWS.AutoScaling.PutWarmPoolType, options: SdkCallOptions): Promise; /** * Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. */ recordLifecycleActionHeartbeat(input: AWS.AutoScaling.RecordLifecycleActionHeartbeatType, options: SdkCallOptions): Promise; /** * Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide. */ resumeProcesses(input: AWS.AutoScaling.ScalingProcessQuery, options: SdkCallOptions): Promise<{}>; /** * Sets the size of the specified Auto Scaling group. If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide. */ setDesiredCapacity(input: AWS.AutoScaling.SetDesiredCapacityType, options: SdkCallOptions): Promise<{}>; /** * Sets the health status of the specified instance. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide. */ setInstanceHealth(input: AWS.AutoScaling.SetInstanceHealthQuery, options: SdkCallOptions): Promise<{}>; /** * Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool. For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails. */ setInstanceProtection(input: AWS.AutoScaling.SetInstanceProtectionQuery, options: SdkCallOptions): Promise; /** * Starts a new instance refresh operation. An instance refresh performs a rolling replacement of all or some instances in an Auto Scaling group. Each instance is terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group. If the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API. */ startInstanceRefresh(input: AWS.AutoScaling.StartInstanceRefreshType, options: SdkCallOptions): Promise; /** * Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group. If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide. To resume processes that have been suspended, call the ResumeProcesses API. */ suspendProcesses(input: AWS.AutoScaling.ScalingProcessQuery, options: SdkCallOptions): Promise<{}>; /** * Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool. This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide. */ terminateInstanceInAutoScalingGroup(input: AWS.AutoScaling.TerminateInstanceInAutoScalingGroupType, options: SdkCallOptions): Promise; /** * We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Updates the configuration for the specified Auto Scaling group. To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns. If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application. Note the following about changing DesiredCapacity, MaxSize, or MinSize: If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value. If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value. To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API. */ updateAutoScalingGroup(input: AWS.AutoScaling.UpdateAutoScalingGroupType, options: SdkCallOptions): Promise<{}>; } export interface AutoScalingPlans { /** * Creates a scaling plan. */ createScalingPlan(input: AWS.AutoScalingPlans.CreateScalingPlanRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.AutoScalingPlans.DeleteScalingPlanRequest, options: SdkCallOptions): Promise; /** * Describes the scalable resources in the specified scaling plan. */ describeScalingPlanResources(input: AWS.AutoScalingPlans.DescribeScalingPlanResourcesRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your scaling plans. */ describeScalingPlans(input: AWS.AutoScalingPlans.DescribeScalingPlansRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.AutoScalingPlans.GetScalingPlanResourceForecastDataRequest, options: SdkCallOptions): Promise; /** * Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted. */ updateScalingPlan(input: AWS.AutoScalingPlans.UpdateScalingPlanRequest, options: SdkCallOptions): Promise; } export interface Backup { /** * Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources. If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception. */ createBackupPlan(input: AWS.Backup.CreateBackupPlanInput, options: SdkCallOptions): Promise; /** * Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically. */ createBackupSelection(input: AWS.Backup.CreateBackupSelectionInput, options: SdkCallOptions): Promise; /** * Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault. */ createBackupVault(input: AWS.Backup.CreateBackupVaultInput, options: SdkCallOptions): Promise; /** * Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance. */ createFramework(input: AWS.Backup.CreateFrameworkInput, options: SdkCallOptions): Promise; /** * Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception. */ createReportPlan(input: AWS.Backup.CreateReportPlanInput, options: SdkCallOptions): Promise; /** * Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist. */ deleteBackupPlan(input: AWS.Backup.DeleteBackupPlanInput, options: SdkCallOptions): Promise; /** * Deletes the resource selection associated with a backup plan that is specified by the SelectionId. */ deleteBackupSelection(input: AWS.Backup.DeleteBackupSelectionInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. */ deleteBackupVault(input: AWS.Backup.DeleteBackupVaultInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the policy document that manages permissions on a backup vault. */ deleteBackupVaultAccessPolicy(input: AWS.Backup.DeleteBackupVaultAccessPolicyInput, options: SdkCallOptions): Promise<{}>; /** * Deletes Backup Vault Lock from a backup vault specified by a backup vault name. If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide. */ deleteBackupVaultLockConfiguration(input: AWS.Backup.DeleteBackupVaultLockConfigurationInput, options: SdkCallOptions): Promise<{}>; /** * Deletes event notifications for the specified backup vault. */ deleteBackupVaultNotifications(input: AWS.Backup.DeleteBackupVaultNotificationsInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the framework specified by a framework name. */ deleteFramework(input: AWS.Backup.DeleteFrameworkInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the recovery point specified by a recovery point ID. If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup. */ deleteRecoveryPoint(input: AWS.Backup.DeleteRecoveryPointInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the report plan specified by a report plan name. */ deleteReportPlan(input: AWS.Backup.DeleteReportPlanInput, options: SdkCallOptions): Promise<{}>; /** * Returns backup job details for the specified BackupJobId. */ describeBackupJob(input: AWS.Backup.DescribeBackupJobInput, options: SdkCallOptions): Promise; /** * Returns metadata about a backup vault specified by its name. */ describeBackupVault(input: AWS.Backup.DescribeBackupVaultInput, options: SdkCallOptions): Promise; /** * Returns metadata associated with creating a copy of a resource. */ describeCopyJob(input: AWS.Backup.DescribeCopyJobInput, options: SdkCallOptions): Promise; /** * Returns the framework details for the specified FrameworkName. */ describeFramework(input: AWS.Backup.DescribeFrameworkInput, options: SdkCallOptions): Promise; /** * Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2 */ describeGlobalSettings(input: AWS.Backup.DescribeGlobalSettingsInput, options: SdkCallOptions): Promise; /** * Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource. */ describeProtectedResource(input: AWS.Backup.DescribeProtectedResourceInput, options: SdkCallOptions): Promise; /** * Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. */ describeRecoveryPoint(input: AWS.Backup.DescribeRecoveryPointInput, options: SdkCallOptions): Promise; /** * Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. */ describeRegionSettings(input: AWS.Backup.DescribeRegionSettingsInput, options: SdkCallOptions): Promise; /** * Returns the details associated with creating a report as specified by its ReportJobId. */ describeReportJob(input: AWS.Backup.DescribeReportJobInput, options: SdkCallOptions): Promise; /** * Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region. */ describeReportPlan(input: AWS.Backup.DescribeReportPlanInput, options: SdkCallOptions): Promise; /** * Returns metadata associated with a restore job that is specified by a job ID. */ describeRestoreJob(input: AWS.Backup.DescribeRestoreJobInput, options: SdkCallOptions): Promise; /** * Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan. Does not support snapshot backup recovery points. */ disassociateRecoveryPoint(input: AWS.Backup.DisassociateRecoveryPointInput, options: SdkCallOptions): Promise<{}>; /** * Returns the backup plan that is specified by the plan ID as a backup template. */ exportBackupPlanTemplate(input: AWS.Backup.ExportBackupPlanTemplateInput, options: SdkCallOptions): Promise; /** * Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata. */ getBackupPlan(input: AWS.Backup.GetBackupPlanInput, options: SdkCallOptions): Promise; /** * Returns a valid JSON document specifying a backup plan or an error. */ getBackupPlanFromJSON(input: AWS.Backup.GetBackupPlanFromJSONInput, options: SdkCallOptions): Promise; /** * Returns the template specified by its templateId as a backup plan. */ getBackupPlanFromTemplate(input: AWS.Backup.GetBackupPlanFromTemplateInput, options: SdkCallOptions): Promise; /** * Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan. */ getBackupSelection(input: AWS.Backup.GetBackupSelectionInput, options: SdkCallOptions): Promise; /** * Returns the access policy document that is associated with the named backup vault. */ getBackupVaultAccessPolicy(input: AWS.Backup.GetBackupVaultAccessPolicyInput, options: SdkCallOptions): Promise; /** * Returns event notifications for the specified backup vault. */ getBackupVaultNotifications(input: AWS.Backup.GetBackupVaultNotificationsInput, options: SdkCallOptions): Promise; /** * Returns a set of metadata key-value pairs that were used to create the backup. */ getRecoveryPointRestoreMetadata(input: AWS.Backup.GetRecoveryPointRestoreMetadataInput, options: SdkCallOptions): Promise; /** * Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools. */ listBackupJobs(input: AWS.Backup.ListBackupJobsInput, options: SdkCallOptions): Promise; /** * Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates. */ listBackupPlanTemplates(input: AWS.Backup.ListBackupPlanTemplatesInput, options: SdkCallOptions): Promise; /** * Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs. */ listBackupPlanVersions(input: AWS.Backup.ListBackupPlanVersionsInput, options: SdkCallOptions): Promise; /** * Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs. */ listBackupPlans(input: AWS.Backup.ListBackupPlansInput, options: SdkCallOptions): Promise; /** * Returns an array containing metadata of the resources associated with the target backup plan. */ listBackupSelections(input: AWS.Backup.ListBackupSelectionsInput, options: SdkCallOptions): Promise; /** * Returns a list of recovery point storage containers along with information about them. */ listBackupVaults(input: AWS.Backup.ListBackupVaultsInput, options: SdkCallOptions): Promise; /** * Returns metadata about your copy jobs. */ listCopyJobs(input: AWS.Backup.ListCopyJobsInput, options: SdkCallOptions): Promise; /** * Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region. */ listFrameworks(input: AWS.Backup.ListFrameworksInput, options: SdkCallOptions): Promise; /** * Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type. */ listProtectedResources(input: AWS.Backup.ListProtectedResourcesInput, options: SdkCallOptions): Promise; /** * Returns detailed information about the recovery points stored in a backup vault. */ listRecoveryPointsByBackupVault(input: AWS.Backup.ListRecoveryPointsByBackupVaultInput, options: SdkCallOptions): Promise; /** * Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup. */ listRecoveryPointsByResource(input: AWS.Backup.ListRecoveryPointsByResourceInput, options: SdkCallOptions): Promise; /** * Returns details about your report jobs. */ listReportJobs(input: AWS.Backup.ListReportJobsInput, options: SdkCallOptions): Promise; /** * Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan. */ listReportPlans(input: AWS.Backup.ListReportPlansInput, options: SdkCallOptions): Promise; /** * Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process. */ listRestoreJobs(input: AWS.Backup.ListRestoreJobsInput, options: SdkCallOptions): Promise; /** * Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. */ listTags(input: AWS.Backup.ListTagsInput, options: SdkCallOptions): Promise; /** * Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format. */ putBackupVaultAccessPolicy(input: AWS.Backup.PutBackupVaultAccessPolicyInput, options: SdkCallOptions): Promise<{}>; /** * Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault. Backup Vault Lock has yet to receive a third-party assessment for SEC 17a-4(f) and CFTC. */ putBackupVaultLockConfiguration(input: AWS.Backup.PutBackupVaultLockConfigurationInput, options: SdkCallOptions): Promise<{}>; /** * Turns on notifications on a backup vault for the specified topic and events. */ putBackupVaultNotifications(input: AWS.Backup.PutBackupVaultNotificationsInput, options: SdkCallOptions): Promise<{}>; /** * Starts an on-demand backup job for the specified resource. */ startBackupJob(input: AWS.Backup.StartBackupJobInput, options: SdkCallOptions): Promise; /** * Starts a job to create a one-time copy of the specified resource. Does not support continuous backups. */ startCopyJob(input: AWS.Backup.StartCopyJobInput, options: SdkCallOptions): Promise; /** * Starts an on-demand report job for the specified report plan. */ startReportJob(input: AWS.Backup.StartReportJobInput, options: SdkCallOptions): Promise; /** * Recovers the saved resource identified by an Amazon Resource Name (ARN). */ startRestoreJob(input: AWS.Backup.StartRestoreJobInput, options: SdkCallOptions): Promise; /** * Attempts to cancel a job to create a one-time backup of a resource. */ stopBackupJob(input: AWS.Backup.StopBackupJobInput, options: SdkCallOptions): Promise<{}>; /** * Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN). */ tagResource(input: AWS.Backup.TagResourceInput, options: SdkCallOptions): Promise<{}>; /** * Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) */ untagResource(input: AWS.Backup.UntagResourceInput, options: SdkCallOptions): Promise<{}>; /** * Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId. */ updateBackupPlan(input: AWS.Backup.UpdateBackupPlanInput, options: SdkCallOptions): Promise; /** * Updates an existing framework identified by its FrameworkName with the input document in JSON format. */ updateFramework(input: AWS.Backup.UpdateFrameworkInput, options: SdkCallOptions): Promise; /** * Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings. */ updateGlobalSettings(input: AWS.Backup.UpdateGlobalSettingsInput, options: SdkCallOptions): Promise<{}>; /** * Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types. This operation does not support continuous backups. */ updateRecoveryPointLifecycle(input: AWS.Backup.UpdateRecoveryPointLifecycleInput, options: SdkCallOptions): Promise; /** * Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported. */ updateRegionSettings(input: AWS.Backup.UpdateRegionSettingsInput, options: SdkCallOptions): Promise<{}>; /** * Updates an existing report plan identified by its ReportPlanName with the input document in JSON format. */ updateReportPlan(input: AWS.Backup.UpdateReportPlanInput, options: SdkCallOptions): Promise; } export interface BackupGateway { /** * 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(input: AWS.BackupGateway.AssociateGatewayToServerInput, options: SdkCallOptions): Promise; /** * Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation. */ createGateway(input: AWS.BackupGateway.CreateGatewayInput, options: SdkCallOptions): Promise; /** * Deletes a backup gateway. */ deleteGateway(input: AWS.BackupGateway.DeleteGatewayInput, options: SdkCallOptions): Promise; /** * Deletes a hypervisor. */ deleteHypervisor(input: AWS.BackupGateway.DeleteHypervisorInput, options: SdkCallOptions): Promise; /** * 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(input: AWS.BackupGateway.DisassociateGatewayFromServerInput, options: SdkCallOptions): Promise; /** * By providing the ARN (Amazon Resource Name), this API returns the gateway. */ getGateway(input: AWS.BackupGateway.GetGatewayInput, options: SdkCallOptions): Promise; /** * By providing the ARN (Amazon Resource Name), this API returns the virtual machine. */ getVirtualMachine(input: AWS.BackupGateway.GetVirtualMachineInput, options: SdkCallOptions): Promise; /** * Connect to a hypervisor by importing its configuration. */ importHypervisorConfiguration(input: AWS.BackupGateway.ImportHypervisorConfigurationInput, options: SdkCallOptions): Promise; /** * 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(input: AWS.BackupGateway.ListGatewaysInput, options: SdkCallOptions): Promise; /** * Lists your hypervisors. */ listHypervisors(input: AWS.BackupGateway.ListHypervisorsInput, options: SdkCallOptions): Promise; /** * Lists the tags applied to the resource identified by its Amazon Resource Name (ARN). */ listTagsForResource(input: AWS.BackupGateway.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Lists your virtual machines. */ listVirtualMachines(input: AWS.BackupGateway.ListVirtualMachinesInput, options: SdkCallOptions): Promise; /** * Set the maintenance start time for a gateway. */ putMaintenanceStartTime(input: AWS.BackupGateway.PutMaintenanceStartTimeInput, options: SdkCallOptions): Promise; /** * Tag the resource. */ tagResource(input: AWS.BackupGateway.TagResourceInput, options: SdkCallOptions): Promise; /** * Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources. */ testHypervisorConfiguration(input: AWS.BackupGateway.TestHypervisorConfigurationInput, options: SdkCallOptions): Promise; /** * Removes tags from the resource. */ untagResource(input: AWS.BackupGateway.UntagResourceInput, options: SdkCallOptions): Promise; /** * Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request. */ updateGatewayInformation(input: AWS.BackupGateway.UpdateGatewayInformationInput, options: SdkCallOptions): Promise; /** * 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(input: AWS.BackupGateway.UpdateGatewaySoftwareNowInput, options: SdkCallOptions): Promise; /** * 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(input: AWS.BackupGateway.UpdateHypervisorInput, options: SdkCallOptions): Promise; } export interface BackupStorage { /** * Delete Object from the incremental base Backup. */ deleteObject(input: AWS.BackupStorage.DeleteObjectInput, options: SdkCallOptions): Promise<{}>; /** * Gets the specified object's chunk. */ getChunk(input: AWS.BackupStorage.GetChunkInput, options: SdkCallOptions): Promise; /** * Get metadata associated with an Object. */ getObjectMetadata(input: AWS.BackupStorage.GetObjectMetadataInput, options: SdkCallOptions): Promise; /** * List chunks in a given Object */ listChunks(input: AWS.BackupStorage.ListChunksInput, options: SdkCallOptions): Promise; /** * List all Objects in a given Backup. */ listObjects(input: AWS.BackupStorage.ListObjectsInput, options: SdkCallOptions): Promise; /** * Complete upload */ notifyObjectComplete(input: AWS.BackupStorage.NotifyObjectCompleteInput, options: SdkCallOptions): Promise; /** * Upload chunk. */ putChunk(input: AWS.BackupStorage.PutChunkInput, options: SdkCallOptions): Promise; /** * Upload object that can store object metadata String and data blob in single API call using inline chunk field. */ putObject(input: AWS.BackupStorage.PutObjectInput, options: SdkCallOptions): Promise; /** * Start upload containing one or many chunks. */ startObject(input: AWS.BackupStorage.StartObjectInput, options: SdkCallOptions): Promise; } export interface Batch { /** * Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation. */ cancelJob(input: AWS.Batch.CancelJobRequest, options: SdkCallOptions): Promise; /** * Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources. In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price. Multi-node parallel jobs aren't supported on Spot Instances. In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide. Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the earlier compute environment from your job queue. Delete the earlier compute environment. In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules: Either do not set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role. Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED. Set the update to latest image version (updateToLatestImageVersion) parameter to true. Do not specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case Batch will select the latest Amazon ECS optimized AMI supported by Batch at the time the infrastructure update is initiated. Alternatively you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties will trigger an infrastructure update. If the AMI ID is specified in the launch template, it can not be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default)or by adding a new version to the launch template (if $Latest). If these rules are followed, any update that triggers an infrastructure update will cause the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template will be evaluated up at the time of the infrastructure update, even if the launchTemplate was not updated. */ createComputeEnvironment(input: AWS.Batch.CreateComputeEnvironmentRequest, options: SdkCallOptions): Promise; /** * Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments. You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment. */ createJobQueue(input: AWS.Batch.CreateJobQueueRequest, options: SdkCallOptions): Promise; /** * Creates an Batch scheduling policy. */ createSchedulingPolicy(input: AWS.Batch.CreateSchedulingPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes an Batch compute environment. Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state. */ deleteComputeEnvironment(input: AWS.Batch.DeleteComputeEnvironmentRequest, options: SdkCallOptions): Promise; /** * Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second. It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request. */ deleteJobQueue(input: AWS.Batch.DeleteJobQueueRequest, options: SdkCallOptions): Promise; /** * Deletes the specified scheduling policy. You can't delete a scheduling policy that's used in any job queues. */ deleteSchedulingPolicy(input: AWS.Batch.DeleteSchedulingPolicyRequest, options: SdkCallOptions): Promise; /** * Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days. */ deregisterJobDefinition(input: AWS.Batch.DeregisterJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your compute environments. If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you launch your Amazon ECS container instances into. */ describeComputeEnvironments(input: AWS.Batch.DescribeComputeEnvironmentsRequest, options: SdkCallOptions): Promise; /** * Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status. */ describeJobDefinitions(input: AWS.Batch.DescribeJobDefinitionsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your job queues. */ describeJobQueues(input: AWS.Batch.DescribeJobQueuesRequest, options: SdkCallOptions): Promise; /** * Describes a list of Batch jobs. */ describeJobs(input: AWS.Batch.DescribeJobsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your scheduling policies. */ describeSchedulingPolicies(input: AWS.Batch.DescribeSchedulingPoliciesRequest, options: SdkCallOptions): Promise; /** * Returns a list of Batch jobs. You must specify only one of the following items: A job queue ID to return a list of jobs in that job queue A multi-node parallel job ID to return a list of nodes for that job An array job ID to return a list of the children for that job You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned. */ listJobs(input: AWS.Batch.ListJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Batch scheduling policies. */ listSchedulingPolicies(input: AWS.Batch.ListSchedulingPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported. */ listTagsForResource(input: AWS.Batch.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Registers an Batch job definition. */ registerJobDefinition(input: AWS.Batch.RegisterJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a resourceRequirements object that's included in the containerOverrides parameter. Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time. Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated. */ submitJob(input: AWS.Batch.SubmitJobRequest, options: SdkCallOptions): Promise; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported. */ tagResource(input: AWS.Batch.TagResourceRequest, options: SdkCallOptions): Promise; /** * Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled. */ terminateJob(input: AWS.Batch.TerminateJobRequest, options: SdkCallOptions): Promise; /** * Deletes specified tags from an Batch resource. */ untagResource(input: AWS.Batch.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an Batch compute environment. */ updateComputeEnvironment(input: AWS.Batch.UpdateComputeEnvironmentRequest, options: SdkCallOptions): Promise; /** * Updates a job queue. */ updateJobQueue(input: AWS.Batch.UpdateJobQueueRequest, options: SdkCallOptions): Promise; /** * Updates a scheduling policy. */ updateSchedulingPolicy(input: AWS.Batch.UpdateSchedulingPolicyRequest, options: SdkCallOptions): Promise; } export interface Billingconductor { /** * Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30. */ associateAccounts(input: AWS.Billingconductor.AssociateAccountsInput, options: SdkCallOptions): Promise; /** * Connects an array of PricingRuleArns to a defined PricingPlan. The maximum number PricingRuleArn that can be associated in one call is 30. */ associatePricingRules(input: AWS.Billingconductor.AssociatePricingRulesInput, options: SdkCallOptions): Promise; /** * Associates a batch of resources to a percentage custom line item. */ batchAssociateResourcesToCustomLineItem(input: AWS.Billingconductor.BatchAssociateResourcesToCustomLineItemInput, options: SdkCallOptions): Promise; /** * Disassociates a batch of resources from a percentage custom line item. */ batchDisassociateResourcesFromCustomLineItem(input: AWS.Billingconductor.BatchDisassociateResourcesFromCustomLineItemInput, options: SdkCallOptions): Promise; /** * Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation. */ createBillingGroup(input: AWS.Billingconductor.CreateBillingGroupInput, options: SdkCallOptions): Promise; /** * Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount. */ createCustomLineItem(input: AWS.Billingconductor.CreateCustomLineItemInput, options: SdkCallOptions): Promise; /** * Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups. */ createPricingPlan(input: AWS.Billingconductor.CreatePricingPlanInput, options: SdkCallOptions): Promise; /** * Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans. */ createPricingRule(input: AWS.Billingconductor.CreatePricingRuleInput, options: SdkCallOptions): Promise; /** * Deletes a billing group. */ deleteBillingGroup(input: AWS.Billingconductor.DeleteBillingGroupInput, options: SdkCallOptions): Promise; /** * Deletes the custom line item identified by the given ARN in the current, or previous billing period. */ deleteCustomLineItem(input: AWS.Billingconductor.DeleteCustomLineItemInput, options: SdkCallOptions): Promise; /** * Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully. */ deletePricingPlan(input: AWS.Billingconductor.DeletePricingPlanInput, options: SdkCallOptions): Promise; /** * Deletes the pricing rule identified by the input Amazon Resource Name (ARN). */ deletePricingRule(input: AWS.Billingconductor.DeletePricingRuleInput, options: SdkCallOptions): Promise; /** * Removes the specified list of account IDs from the given billing group. */ disassociateAccounts(input: AWS.Billingconductor.DisassociateAccountsInput, options: SdkCallOptions): Promise; /** * Disassociates a list of pricing rules from a pricing plan. */ disassociatePricingRules(input: AWS.Billingconductor.DisassociatePricingRulesInput, options: SdkCallOptions): Promise; /** * Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10). This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group associated with the linked account. */ listAccountAssociations(input: AWS.Billingconductor.ListAccountAssociationsInput, options: SdkCallOptions): Promise; /** * A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group. */ listBillingGroupCostReports(input: AWS.Billingconductor.ListBillingGroupCostReportsInput, options: SdkCallOptions): Promise; /** * A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used. */ listBillingGroups(input: AWS.Billingconductor.ListBillingGroupsInput, options: SdkCallOptions): Promise; /** * A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used. */ listCustomLineItems(input: AWS.Billingconductor.ListCustomLineItemsInput, options: SdkCallOptions): Promise; /** * A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used. */ listPricingPlans(input: AWS.Billingconductor.ListPricingPlansInput, options: SdkCallOptions): Promise; /** * A list of the pricing plans associated with a pricing rule. */ listPricingPlansAssociatedWithPricingRule(input: AWS.Billingconductor.ListPricingPlansAssociatedWithPricingRuleInput, options: SdkCallOptions): Promise; /** * Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans. */ listPricingRules(input: AWS.Billingconductor.ListPricingRulesInput, options: SdkCallOptions): Promise; /** * Lists the pricing rules associated with a pricing plan. */ listPricingRulesAssociatedToPricingPlan(input: AWS.Billingconductor.ListPricingRulesAssociatedToPricingPlanInput, options: SdkCallOptions): Promise; /** * List the resources associated to a custom line item. */ listResourcesAssociatedToCustomLineItem(input: AWS.Billingconductor.ListResourcesAssociatedToCustomLineItemInput, options: SdkCallOptions): Promise; /** * A list the tags for a resource. */ listTagsForResource(input: AWS.Billingconductor.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. */ tagResource(input: AWS.Billingconductor.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes specified tags from a resource. */ untagResource(input: AWS.Billingconductor.UntagResourceRequest, options: SdkCallOptions): Promise; /** * This updates an existing billing group. */ updateBillingGroup(input: AWS.Billingconductor.UpdateBillingGroupInput, options: SdkCallOptions): Promise; /** * Update an existing custom line item in the current or previous billing period. */ updateCustomLineItem(input: AWS.Billingconductor.UpdateCustomLineItemInput, options: SdkCallOptions): Promise; /** * This updates an existing pricing plan. */ updatePricingPlan(input: AWS.Billingconductor.UpdatePricingPlanInput, options: SdkCallOptions): Promise; /** * Updates an existing pricing rule. */ updatePricingRule(input: AWS.Billingconductor.UpdatePricingRuleInput, options: SdkCallOptions): Promise; } export interface Braket { /** * Cancels an Amazon Braket job. */ cancelJob(input: AWS.Braket.CancelJobRequest, options: SdkCallOptions): Promise; /** * Cancels the specified task. */ cancelQuantumTask(input: AWS.Braket.CancelQuantumTaskRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Braket job. */ createJob(input: AWS.Braket.CreateJobRequest, options: SdkCallOptions): Promise; /** * Creates a quantum task. */ createQuantumTask(input: AWS.Braket.CreateQuantumTaskRequest, options: SdkCallOptions): Promise; /** * 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(input: AWS.Braket.GetDeviceRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified Amazon Braket job. */ getJob(input: AWS.Braket.GetJobRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified quantum task. */ getQuantumTask(input: AWS.Braket.GetQuantumTaskRequest, options: SdkCallOptions): Promise; /** * Shows the tags associated with this resource. */ listTagsForResource(input: AWS.Braket.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Searches for devices using the specified filters. */ searchDevices(input: AWS.Braket.SearchDevicesRequest, options: SdkCallOptions): Promise; /** * Searches for Amazon Braket jobs that match the specified filter values. */ searchJobs(input: AWS.Braket.SearchJobsRequest, options: SdkCallOptions): Promise; /** * Searches for tasks that match the specified filter values. */ searchQuantumTasks(input: AWS.Braket.SearchQuantumTasksRequest, options: SdkCallOptions): Promise; /** * Add a tag to the specified resource. */ tagResource(input: AWS.Braket.TagResourceRequest, options: SdkCallOptions): Promise; /** * Remove tags from a resource. */ untagResource(input: AWS.Braket.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface Budgets { /** * Creates a budget and, if included, notifications and subscribers. Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section. */ createBudget(input: AWS.Budgets.CreateBudgetRequest, options: SdkCallOptions): Promise; /** * Creates a budget action. */ createBudgetAction(input: AWS.Budgets.CreateBudgetActionRequest, options: SdkCallOptions): Promise; /** * Creates a notification. You must create the budget before you create the associated notification. */ createNotification(input: AWS.Budgets.CreateNotificationRequest, options: SdkCallOptions): Promise; /** * Creates a subscriber. You must create the associated budget and notification before you create the subscriber. */ createSubscriber(input: AWS.Budgets.CreateSubscriberRequest, options: SdkCallOptions): Promise; /** * Deletes a budget. You can delete your budget at any time. Deleting a budget also deletes the notifications and subscribers that are associated with that budget. */ deleteBudget(input: AWS.Budgets.DeleteBudgetRequest, options: SdkCallOptions): Promise; /** * Deletes a budget action. */ deleteBudgetAction(input: AWS.Budgets.DeleteBudgetActionRequest, options: SdkCallOptions): Promise; /** * Deletes a notification. Deleting a notification also deletes the subscribers that are associated with the notification. */ deleteNotification(input: AWS.Budgets.DeleteNotificationRequest, options: SdkCallOptions): Promise; /** * Deletes a subscriber. Deleting the last subscriber to a notification also deletes the notification. */ deleteSubscriber(input: AWS.Budgets.DeleteSubscriberRequest, options: SdkCallOptions): Promise; /** * Describes a budget. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section. */ describeBudget(input: AWS.Budgets.DescribeBudgetRequest, options: SdkCallOptions): Promise; /** * Describes a budget action detail. */ describeBudgetAction(input: AWS.Budgets.DescribeBudgetActionRequest, options: SdkCallOptions): Promise; /** * Describes a budget action history detail. */ describeBudgetActionHistories(input: AWS.Budgets.DescribeBudgetActionHistoriesRequest, options: SdkCallOptions): Promise; /** * Describes all of the budget actions for an account. */ describeBudgetActionsForAccount(input: AWS.Budgets.DescribeBudgetActionsForAccountRequest, options: SdkCallOptions): Promise; /** * Describes all of the budget actions for a budget. */ describeBudgetActionsForBudget(input: AWS.Budgets.DescribeBudgetActionsForBudgetRequest, options: SdkCallOptions): Promise; /** * Lists the budget names and notifications that are associated with an account. */ describeBudgetNotificationsForAccount(input: AWS.Budgets.DescribeBudgetNotificationsForAccountRequest, options: SdkCallOptions): Promise; /** * Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets. */ describeBudgetPerformanceHistory(input: AWS.Budgets.DescribeBudgetPerformanceHistoryRequest, options: SdkCallOptions): Promise; /** * Lists the budgets that are associated with an account. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section. */ describeBudgets(input: AWS.Budgets.DescribeBudgetsRequest, options: SdkCallOptions): Promise; /** * Lists the notifications that are associated with a budget. */ describeNotificationsForBudget(input: AWS.Budgets.DescribeNotificationsForBudgetRequest, options: SdkCallOptions): Promise; /** * Lists the subscribers that are associated with a notification. */ describeSubscribersForNotification(input: AWS.Budgets.DescribeSubscribersForNotificationRequest, options: SdkCallOptions): Promise; /** * Executes a budget action. */ executeBudgetAction(input: AWS.Budgets.ExecuteBudgetActionRequest, options: SdkCallOptions): Promise; /** * Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services has new usage data to use for forecasting. Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section. */ updateBudget(input: AWS.Budgets.UpdateBudgetRequest, options: SdkCallOptions): Promise; /** * Updates a budget action. */ updateBudgetAction(input: AWS.Budgets.UpdateBudgetActionRequest, options: SdkCallOptions): Promise; /** * Updates a notification. */ updateNotification(input: AWS.Budgets.UpdateNotificationRequest, options: SdkCallOptions): Promise; /** * Updates a subscriber. */ updateSubscriber(input: AWS.Budgets.UpdateSubscriberRequest, options: SdkCallOptions): Promise; } export interface Chime { /** * Associates a phone number with the specified Amazon Chime user. */ associatePhoneNumberWithUser(input: AWS.Chime.AssociatePhoneNumberWithUserRequest, options: SdkCallOptions): Promise; /** * Associates phone numbers with the specified Amazon Chime Voice Connector. */ associatePhoneNumbersWithVoiceConnector(input: AWS.Chime.AssociatePhoneNumbersWithVoiceConnectorRequest, options: SdkCallOptions): Promise; /** * Associates phone numbers with the specified Amazon Chime Voice Connector group. */ associatePhoneNumbersWithVoiceConnectorGroup(input: AWS.Chime.AssociatePhoneNumbersWithVoiceConnectorGroupRequest, options: SdkCallOptions): Promise; /** * Associates the specified sign-in delegate groups with the specified Amazon Chime account. */ associateSigninDelegateGroupsWithAccount(input: AWS.Chime.AssociateSigninDelegateGroupsWithAccountRequest, options: SdkCallOptions): Promise; /** * Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ batchCreateAttendee(input: AWS.Chime.BatchCreateAttendeeRequest, options: SdkCallOptions): Promise; /** * Adds a specified number of users to a channel. */ batchCreateChannelMembership(input: AWS.Chime.BatchCreateChannelMembershipRequest, options: SdkCallOptions): Promise; /** * Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member. */ batchCreateRoomMembership(input: AWS.Chime.BatchCreateRoomMembershipRequest, options: SdkCallOptions): Promise; /** * Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. */ batchDeletePhoneNumber(input: AWS.Chime.BatchDeletePhoneNumberRequest, options: SdkCallOptions): Promise; /** * Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action. */ batchSuspendUser(input: AWS.Chime.BatchSuspendUserRequest, options: SdkCallOptions): Promise; /** * Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored. */ batchUnsuspendUser(input: AWS.Chime.BatchUnsuspendUserRequest, options: SdkCallOptions): Promise; /** * Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update. */ batchUpdatePhoneNumber(input: AWS.Chime.BatchUpdatePhoneNumberRequest, options: SdkCallOptions): Promise; /** * Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action. */ batchUpdateUser(input: AWS.Chime.BatchUpdateUserRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. */ createAccount(input: AWS.Chime.CreateAccountRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. */ createAppInstance(input: AWS.Chime.CreateAppInstanceRequest, options: SdkCallOptions): Promise; /** * Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser can be promoted to an AppInstanceAdmin role. */ createAppInstanceAdmin(input: AWS.Chime.CreateAppInstanceAdminRequest, options: SdkCallOptions): Promise; /** * Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user. */ createAppInstanceUser(input: AWS.Chime.CreateAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ createAttendee(input: AWS.Chime.CreateAttendeeRequest, options: SdkCallOptions): Promise; /** * Creates a bot for an Amazon Chime Enterprise account. */ createBot(input: AWS.Chime.CreateBotRequest, options: SdkCallOptions): Promise; /** * Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannel(input: AWS.Chime.CreateChannelRequest, options: SdkCallOptions): Promise; /** * Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelBan(input: AWS.Chime.CreateChannelBanRequest, options: SdkCallOptions): Promise; /** * Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can: List messages Send messages Receive messages Edit their own messages Leave the channel Privacy settings impact this action as follows: Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelMembership(input: AWS.Chime.CreateChannelMembershipRequest, options: SdkCallOptions): Promise; /** * Creates a new ChannelModerator. A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelModerator(input: AWS.Chime.CreateChannelModeratorRequest, options: SdkCallOptions): Promise; /** * Creates a media capture pipeline. */ createMediaCapturePipeline(input: AWS.Chime.CreateMediaCapturePipelineRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide . */ createMeeting(input: AWS.Chime.CreateMeetingRequest, options: SdkCallOptions): Promise; /** * Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer. To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID. */ createMeetingDialOut(input: AWS.Chime.CreateMeetingDialOutRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide . */ createMeetingWithAttendees(input: AWS.Chime.CreateMeetingWithAttendeesRequest, options: SdkCallOptions): Promise; /** * Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. */ createPhoneNumberOrder(input: AWS.Chime.CreatePhoneNumberOrderRequest, options: SdkCallOptions): Promise; /** * Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers. */ createProxySession(input: AWS.Chime.CreateProxySessionRequest, options: SdkCallOptions): Promise; /** * Creates a chat room for the specified Amazon Chime Enterprise account. */ createRoom(input: AWS.Chime.CreateRoomRequest, options: SdkCallOptions): Promise; /** * Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member. */ createRoomMembership(input: AWS.Chime.CreateRoomMembershipRequest, options: SdkCallOptions): Promise; /** * Creates a SIP media application. */ createSipMediaApplication(input: AWS.Chime.CreateSipMediaApplicationRequest, options: SdkCallOptions): Promise; /** * Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId. */ createSipMediaApplicationCall(input: AWS.Chime.CreateSipMediaApplicationCallRequest, options: SdkCallOptions): Promise; /** * Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type. */ createSipRule(input: AWS.Chime.CreateSipRuleRequest, options: SdkCallOptions): Promise; /** * Creates a user under the specified Amazon Chime account. */ createUser(input: AWS.Chime.CreateUserRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked. */ createVoiceConnector(input: AWS.Chime.CreateVoiceConnectorRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events. */ createVoiceConnectorGroup(input: AWS.Chime.CreateVoiceConnectorGroupRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list. */ deleteAccount(input: AWS.Chime.DeleteAccountRequest, options: SdkCallOptions): Promise; /** * Deletes an AppInstance and all associated data asynchronously. */ deleteAppInstance(input: AWS.Chime.DeleteAppInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user. */ deleteAppInstanceAdmin(input: AWS.Chime.DeleteAppInstanceAdminRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the streaming configurations of an AppInstance. */ deleteAppInstanceStreamingConfigurations(input: AWS.Chime.DeleteAppInstanceStreamingConfigurationsRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an AppInstanceUser. */ deleteAppInstanceUser(input: AWS.Chime.DeleteAppInstanceUserRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ deleteAttendee(input: AWS.Chime.DeleteAttendeeRequest, options: SdkCallOptions): Promise<{}>; /** * Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannel(input: AWS.Chime.DeleteChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Removes a user from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelBan(input: AWS.Chime.DeleteChannelBanRequest, options: SdkCallOptions): Promise<{}>; /** * Removes a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelMembership(input: AWS.Chime.DeleteChannelMembershipRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelMessage(input: AWS.Chime.DeleteChannelMessageRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelModerator(input: AWS.Chime.DeleteChannelModeratorRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the events configuration that allows a bot to receive outgoing events. */ deleteEventsConfiguration(input: AWS.Chime.DeleteEventsConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the media capture pipeline. */ deleteMediaCapturePipeline(input: AWS.Chime.DeleteMediaCapturePipelineRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ deleteMeeting(input: AWS.Chime.DeleteMeetingRequest, options: SdkCallOptions): Promise<{}>; /** * Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. */ deletePhoneNumber(input: AWS.Chime.DeletePhoneNumberRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified proxy session from the specified Amazon Chime Voice Connector. */ deleteProxySession(input: AWS.Chime.DeleteProxySessionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a chat room in an Amazon Chime Enterprise account. */ deleteRoom(input: AWS.Chime.DeleteRoomRequest, options: SdkCallOptions): Promise<{}>; /** * Removes a member from a chat room in an Amazon Chime Enterprise account. */ deleteRoomMembership(input: AWS.Chime.DeleteRoomMembershipRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a SIP media application. */ deleteSipMediaApplication(input: AWS.Chime.DeleteSipMediaApplicationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a SIP rule. You must disable a SIP rule before you can delete it. */ deleteSipRule(input: AWS.Chime.DeleteSipRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted. */ deleteVoiceConnector(input: AWS.Chime.DeleteVoiceConnectorRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector. */ deleteVoiceConnectorEmergencyCallingConfiguration(input: AWS.Chime.DeleteVoiceConnectorEmergencyCallingConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted. */ deleteVoiceConnectorGroup(input: AWS.Chime.DeleteVoiceConnectorGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the origination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings. */ deleteVoiceConnectorOrigination(input: AWS.Chime.DeleteVoiceConnectorOriginationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the proxy configuration from the specified Amazon Chime Voice Connector. */ deleteVoiceConnectorProxy(input: AWS.Chime.DeleteVoiceConnectorProxyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the streaming configuration for the specified Amazon Chime Voice Connector. */ deleteVoiceConnectorStreamingConfiguration(input: AWS.Chime.DeleteVoiceConnectorStreamingConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the termination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings. */ deleteVoiceConnectorTermination(input: AWS.Chime.DeleteVoiceConnectorTerminationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified SIP credentials used by your equipment to authenticate during call termination. */ deleteVoiceConnectorTerminationCredentials(input: AWS.Chime.DeleteVoiceConnectorTerminationCredentialsRequest, options: SdkCallOptions): Promise<{}>; /** * Returns the full details of an AppInstance. */ describeAppInstance(input: AWS.Chime.DescribeAppInstanceRequest, options: SdkCallOptions): Promise; /** * Returns the full details of an AppInstanceAdmin. */ describeAppInstanceAdmin(input: AWS.Chime.DescribeAppInstanceAdminRequest, options: SdkCallOptions): Promise; /** * Returns the full details of an AppInstanceUser. */ describeAppInstanceUser(input: AWS.Chime.DescribeAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannel(input: AWS.Chime.DescribeChannelRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelBan(input: AWS.Chime.DescribeChannelBanRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelMembership(input: AWS.Chime.DescribeChannelMembershipRequest, options: SdkCallOptions): Promise; /** * Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelMembershipForAppInstanceUser(input: AWS.Chime.DescribeChannelMembershipForAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelModeratedByAppInstanceUser(input: AWS.Chime.DescribeChannelModeratedByAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelModerator(input: AWS.Chime.DescribeChannelModeratorRequest, options: SdkCallOptions): Promise; /** * Disassociates the primary provisioned phone number from the specified Amazon Chime user. */ disassociatePhoneNumberFromUser(input: AWS.Chime.DisassociatePhoneNumberFromUserRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector. */ disassociatePhoneNumbersFromVoiceConnector(input: AWS.Chime.DisassociatePhoneNumbersFromVoiceConnectorRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group. */ disassociatePhoneNumbersFromVoiceConnectorGroup(input: AWS.Chime.DisassociatePhoneNumbersFromVoiceConnectorGroupRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified sign-in delegate groups from the specified Amazon Chime account. */ disassociateSigninDelegateGroupsFromAccount(input: AWS.Chime.DisassociateSigninDelegateGroupsFromAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves details for the specified Amazon Chime account, such as account type and supported licenses. */ getAccount(input: AWS.Chime.GetAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide. */ getAccountSettings(input: AWS.Chime.GetAccountSettingsRequest, options: SdkCallOptions): Promise; /** * Gets the retention settings for an AppInstance. */ getAppInstanceRetentionSettings(input: AWS.Chime.GetAppInstanceRetentionSettingsRequest, options: SdkCallOptions): Promise; /** * Gets the streaming settings for an AppInstance. */ getAppInstanceStreamingConfigurations(input: AWS.Chime.GetAppInstanceStreamingConfigurationsRequest, options: SdkCallOptions): Promise; /** * Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide . */ getAttendee(input: AWS.Chime.GetAttendeeRequest, options: SdkCallOptions): Promise; /** * Retrieves details for the specified bot, such as bot email address, bot type, status, and display name. */ getBot(input: AWS.Chime.GetBotRequest, options: SdkCallOptions): Promise; /** * Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ getChannelMessage(input: AWS.Chime.GetChannelMessageRequest, options: SdkCallOptions): Promise; /** * Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN. */ getEventsConfiguration(input: AWS.Chime.GetEventsConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets an existing media capture pipeline. */ getMediaCapturePipeline(input: AWS.Chime.GetMediaCapturePipelineRequest, options: SdkCallOptions): Promise; /** * Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide . */ getMeeting(input: AWS.Chime.GetMeetingRequest, options: SdkCallOptions): Promise; /** * The details of the endpoint for the messaging session. */ getMessagingSessionEndpoint(input: AWS.Chime.GetMessagingSessionEndpointRequest, options: SdkCallOptions): Promise; /** * Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. */ getPhoneNumber(input: AWS.Chime.GetPhoneNumberRequest, options: SdkCallOptions): Promise; /** * Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status. */ getPhoneNumberOrder(input: AWS.Chime.GetPhoneNumberOrderRequest, options: SdkCallOptions): Promise; /** * Gets the specified proxy session details for the specified Amazon Chime Voice Connector. */ getProxySession(input: AWS.Chime.GetProxySessionRequest, options: SdkCallOptions): Promise; /** * Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide. */ getRetentionSettings(input: AWS.Chime.GetRetentionSettingsRequest, options: SdkCallOptions): Promise; /** * Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account. */ getRoom(input: AWS.Chime.GetRoomRequest, options: SdkCallOptions): Promise; /** * Retrieves the information for a SIP media application, including name, AWS Region, and endpoints. */ getSipMediaApplication(input: AWS.Chime.GetSipMediaApplicationRequest, options: SdkCallOptions): Promise; /** * Returns the logging configuration for the specified SIP media application. */ getSipMediaApplicationLoggingConfiguration(input: AWS.Chime.GetSipMediaApplicationLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints. */ getSipRule(input: AWS.Chime.GetSipRuleRequest, options: SdkCallOptions): Promise; /** * Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN. To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address. */ getUser(input: AWS.Chime.GetUserRequest, options: SdkCallOptions): Promise; /** * Retrieves settings for the specified user ID, such as any associated phone number settings. */ getUserSettings(input: AWS.Chime.GetUserSettingsRequest, options: SdkCallOptions): Promise; /** * Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements. */ getVoiceConnector(input: AWS.Chime.GetVoiceConnectorRequest, options: SdkCallOptions): Promise; /** * Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector. */ getVoiceConnectorEmergencyCallingConfiguration(input: AWS.Chime.GetVoiceConnectorEmergencyCallingConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems. */ getVoiceConnectorGroup(input: AWS.Chime.GetVoiceConnectorGroupRequest, options: SdkCallOptions): Promise; /** * Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs. */ getVoiceConnectorLoggingConfiguration(input: AWS.Chime.GetVoiceConnectorLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves origination setting details for the specified Amazon Chime Voice Connector. */ getVoiceConnectorOrigination(input: AWS.Chime.GetVoiceConnectorOriginationRequest, options: SdkCallOptions): Promise; /** * Gets the proxy configuration details for the specified Amazon Chime Voice Connector. */ getVoiceConnectorProxy(input: AWS.Chime.GetVoiceConnectorProxyRequest, options: SdkCallOptions): Promise; /** * Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data. */ getVoiceConnectorStreamingConfiguration(input: AWS.Chime.GetVoiceConnectorStreamingConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves termination setting details for the specified Amazon Chime Voice Connector. */ getVoiceConnectorTermination(input: AWS.Chime.GetVoiceConnectorTerminationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector. */ getVoiceConnectorTerminationHealth(input: AWS.Chime.GetVoiceConnectorTerminationHealthRequest, options: SdkCallOptions): Promise; /** * Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action. */ inviteUsers(input: AWS.Chime.InviteUsersRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result. */ listAccounts(input: AWS.Chime.ListAccountsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the administrators in the AppInstance. */ listAppInstanceAdmins(input: AWS.Chime.ListAppInstanceAdminsRequest, options: SdkCallOptions): Promise; /** * List all AppInstanceUsers created under a single AppInstance. */ listAppInstanceUsers(input: AWS.Chime.ListAppInstanceUsersRequest, options: SdkCallOptions): Promise; /** * Lists all Amazon Chime AppInstances created under a single AWS account. */ listAppInstances(input: AWS.Chime.ListAppInstancesRequest, options: SdkCallOptions): Promise; /** * Lists the tags applied to an Amazon Chime SDK attendee resource. */ listAttendeeTags(input: AWS.Chime.ListAttendeeTagsRequest, options: SdkCallOptions): Promise; /** * Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ listAttendees(input: AWS.Chime.ListAttendeesRequest, options: SdkCallOptions): Promise; /** * Lists the bots associated with the administrator's Amazon Chime Enterprise account ID. */ listBots(input: AWS.Chime.ListBotsRequest, options: SdkCallOptions): Promise; /** * Lists all the users banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelBans(input: AWS.Chime.ListChannelBansRequest, options: SdkCallOptions): Promise; /** * Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMemberships(input: AWS.Chime.ListChannelMembershipsRequest, options: SdkCallOptions): Promise; /** * Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMembershipsForAppInstanceUser(input: AWS.Chime.ListChannelMembershipsForAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order. Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMessages(input: AWS.Chime.ListChannelMessagesRequest, options: SdkCallOptions): Promise; /** * Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelModerators(input: AWS.Chime.ListChannelModeratorsRequest, options: SdkCallOptions): Promise; /** * Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality & restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannels(input: AWS.Chime.ListChannelsRequest, options: SdkCallOptions): Promise; /** * A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelsModeratedByAppInstanceUser(input: AWS.Chime.ListChannelsModeratedByAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Returns a list of media capture pipelines. */ listMediaCapturePipelines(input: AWS.Chime.ListMediaCapturePipelinesRequest, options: SdkCallOptions): Promise; /** * Lists the tags applied to an Amazon Chime SDK meeting resource. */ listMeetingTags(input: AWS.Chime.ListMeetingTagsRequest, options: SdkCallOptions): Promise; /** * Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ listMeetings(input: AWS.Chime.ListMeetingsRequest, options: SdkCallOptions): Promise; /** * Lists the phone number orders for the administrator's Amazon Chime account. */ listPhoneNumberOrders(input: AWS.Chime.ListPhoneNumberOrdersRequest, options: SdkCallOptions): Promise; /** * Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group. */ listPhoneNumbers(input: AWS.Chime.ListPhoneNumbersRequest, options: SdkCallOptions): Promise; /** * Lists the proxy sessions for the specified Amazon Chime Voice Connector. */ listProxySessions(input: AWS.Chime.ListProxySessionsRequest, options: SdkCallOptions): Promise; /** * Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names. */ listRoomMemberships(input: AWS.Chime.ListRoomMembershipsRequest, options: SdkCallOptions): Promise; /** * Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to. */ listRooms(input: AWS.Chime.ListRoomsRequest, options: SdkCallOptions): Promise; /** * Lists the SIP media applications under the administrator's AWS account. */ listSipMediaApplications(input: AWS.Chime.ListSipMediaApplicationsRequest, options: SdkCallOptions): Promise; /** * Lists the SIP rules under the administrator's AWS account. */ listSipRules(input: AWS.Chime.ListSipRulesRequest, options: SdkCallOptions): Promise; /** * Lists supported phone number countries. */ listSupportedPhoneNumberCountries(input: AWS.Chime.ListSupportedPhoneNumberCountriesRequest, options: SdkCallOptions): Promise; /** * Lists the tags applied to an Amazon Chime SDK meeting resource. */ listTagsForResource(input: AWS.Chime.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to. */ listUsers(input: AWS.Chime.ListUsersRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon Chime Voice Connector groups for the administrator's AWS account. */ listVoiceConnectorGroups(input: AWS.Chime.ListVoiceConnectorGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the SIP credentials for the specified Amazon Chime Voice Connector. */ listVoiceConnectorTerminationCredentials(input: AWS.Chime.ListVoiceConnectorTerminationCredentialsRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon Chime Voice Connectors for the administrator's AWS account. */ listVoiceConnectors(input: AWS.Chime.ListVoiceConnectorsRequest, options: SdkCallOptions): Promise; /** * Logs out the specified user from all of the devices they are currently logged into. */ logoutUser(input: AWS.Chime.LogoutUserRequest, options: SdkCallOptions): Promise; /** * Sets the amount of time in days that a given AppInstance retains data. */ putAppInstanceRetentionSettings(input: AWS.Chime.PutAppInstanceRetentionSettingsRequest, options: SdkCallOptions): Promise; /** * The data streaming configurations of an AppInstance. */ putAppInstanceStreamingConfigurations(input: AWS.Chime.PutAppInstanceStreamingConfigurationsRequest, options: SdkCallOptions): Promise; /** * Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot. */ putEventsConfiguration(input: AWS.Chime.PutEventsConfigurationRequest, options: SdkCallOptions): Promise; /** * Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide. To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide. */ putRetentionSettings(input: AWS.Chime.PutRetentionSettingsRequest, options: SdkCallOptions): Promise; /** * Updates the logging configuration for the specified SIP media application. */ putSipMediaApplicationLoggingConfiguration(input: AWS.Chime.PutSipMediaApplicationLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured. */ putVoiceConnectorEmergencyCallingConfiguration(input: AWS.Chime.PutVoiceConnectorEmergencyCallingConfigurationRequest, options: SdkCallOptions): Promise; /** * Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs. */ putVoiceConnectorLoggingConfiguration(input: AWS.Chime.PutVoiceConnectorLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Adds origination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings. */ putVoiceConnectorOrigination(input: AWS.Chime.PutVoiceConnectorOriginationRequest, options: SdkCallOptions): Promise; /** * Puts the specified proxy configuration to the specified Amazon Chime Voice Connector. */ putVoiceConnectorProxy(input: AWS.Chime.PutVoiceConnectorProxyRequest, options: SdkCallOptions): Promise; /** * Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data. */ putVoiceConnectorStreamingConfiguration(input: AWS.Chime.PutVoiceConnectorStreamingConfigurationRequest, options: SdkCallOptions): Promise; /** * Adds termination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings. */ putVoiceConnectorTermination(input: AWS.Chime.PutVoiceConnectorTerminationRequest, options: SdkCallOptions): Promise; /** * Adds termination SIP credentials for the specified Amazon Chime Voice Connector. */ putVoiceConnectorTerminationCredentials(input: AWS.Chime.PutVoiceConnectorTerminationCredentialsRequest, options: SdkCallOptions): Promise<{}>; /** * Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ redactChannelMessage(input: AWS.Chime.RedactChannelMessageRequest, options: SdkCallOptions): Promise; /** * Redacts the specified message from the specified Amazon Chime conversation. */ redactConversationMessage(input: AWS.Chime.RedactConversationMessageRequest, options: SdkCallOptions): Promise; /** * Redacts the specified message from the specified Amazon Chime channel. */ redactRoomMessage(input: AWS.Chime.RedactRoomMessageRequest, options: SdkCallOptions): Promise; /** * Regenerates the security token for a bot. */ regenerateSecurityToken(input: AWS.Chime.RegenerateSecurityTokenRequest, options: SdkCallOptions): Promise; /** * Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN. */ resetPersonalPIN(input: AWS.Chime.ResetPersonalPINRequest, options: SdkCallOptions): Promise; /** * Moves a phone number from the Deletion queue back into the phone number Inventory. */ restorePhoneNumber(input: AWS.Chime.RestorePhoneNumberRequest, options: SdkCallOptions): Promise; /** * Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use. */ searchAvailablePhoneNumbers(input: AWS.Chime.SearchAvailablePhoneNumbersRequest, options: SdkCallOptions): Promise; /** * Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata. */ sendChannelMessage(input: AWS.Chime.SendChannelMessageRequest, options: SdkCallOptions): Promise; /** * Starts transcription for the specified meetingId. */ startMeetingTranscription(input: AWS.Chime.StartMeetingTranscriptionRequest, options: SdkCallOptions): Promise; /** * Stops transcription for the specified meetingId. */ stopMeetingTranscription(input: AWS.Chime.StopMeetingTranscriptionRequest, options: SdkCallOptions): Promise; /** * Applies the specified tags to the specified Amazon Chime SDK attendee. */ tagAttendee(input: AWS.Chime.TagAttendeeRequest, options: SdkCallOptions): Promise<{}>; /** * Applies the specified tags to the specified Amazon Chime SDK meeting. */ tagMeeting(input: AWS.Chime.TagMeetingRequest, options: SdkCallOptions): Promise<{}>; /** * Applies the specified tags to the specified Amazon Chime SDK meeting resource. */ tagResource(input: AWS.Chime.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Untags the specified tags from the specified Amazon Chime SDK attendee. */ untagAttendee(input: AWS.Chime.UntagAttendeeRequest, options: SdkCallOptions): Promise<{}>; /** * Untags the specified tags from the specified Amazon Chime SDK meeting. */ untagMeeting(input: AWS.Chime.UntagMeetingRequest, options: SdkCallOptions): Promise<{}>; /** * Untags the specified tags from the specified Amazon Chime SDK meeting resource. */ untagResource(input: AWS.Chime.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action. */ updateAccount(input: AWS.Chime.UpdateAccountRequest, options: SdkCallOptions): Promise; /** * Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide. */ updateAccountSettings(input: AWS.Chime.UpdateAccountSettingsRequest, options: SdkCallOptions): Promise; /** * Updates AppInstance metadata. */ updateAppInstance(input: AWS.Chime.UpdateAppInstanceRequest, options: SdkCallOptions): Promise; /** * Updates the details of an AppInstanceUser. You can update names and metadata. */ updateAppInstanceUser(input: AWS.Chime.UpdateAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account. */ updateBot(input: AWS.Chime.UpdateBotRequest, options: SdkCallOptions): Promise; /** * Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannel(input: AWS.Chime.UpdateChannelRequest, options: SdkCallOptions): Promise; /** * Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannelMessage(input: AWS.Chime.UpdateChannelMessageRequest, options: SdkCallOptions): Promise; /** * The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannelReadMarker(input: AWS.Chime.UpdateChannelReadMarkerRequest, options: SdkCallOptions): Promise; /** * Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. */ updateGlobalSettings(input: AWS.Chime.UpdateGlobalSettingsRequest, options: SdkCallOptions): Promise<{}>; /** * Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update. */ updatePhoneNumber(input: AWS.Chime.UpdatePhoneNumberRequest, options: SdkCallOptions): Promise; /** * Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update. */ updatePhoneNumberSettings(input: AWS.Chime.UpdatePhoneNumberSettingsRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the specified proxy session details, such as voice or SMS capabilities. */ updateProxySession(input: AWS.Chime.UpdateProxySessionRequest, options: SdkCallOptions): Promise; /** * Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account. */ updateRoom(input: AWS.Chime.UpdateRoomRequest, options: SdkCallOptions): Promise; /** * Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs. */ updateRoomMembership(input: AWS.Chime.UpdateRoomMembershipRequest, options: SdkCallOptions): Promise; /** * Updates the details of the specified SIP media application. */ updateSipMediaApplication(input: AWS.Chime.UpdateSipMediaApplicationRequest, options: SdkCallOptions): Promise; /** * Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions. */ updateSipMediaApplicationCall(input: AWS.Chime.UpdateSipMediaApplicationCallRequest, options: SdkCallOptions): Promise; /** * Updates the details of the specified SIP rule. */ updateSipRule(input: AWS.Chime.UpdateSipRuleRequest, options: SdkCallOptions): Promise; /** * Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action. */ updateUser(input: AWS.Chime.UpdateUserRequest, options: SdkCallOptions): Promise; /** * Updates the settings for the specified user, such as phone number settings. */ updateUserSettings(input: AWS.Chime.UpdateUserSettingsRequest, options: SdkCallOptions): Promise<{}>; /** * Updates details for the specified Amazon Chime Voice Connector. */ updateVoiceConnector(input: AWS.Chime.UpdateVoiceConnectorRequest, options: SdkCallOptions): Promise; /** * Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking. */ updateVoiceConnectorGroup(input: AWS.Chime.UpdateVoiceConnectorGroupRequest, options: SdkCallOptions): Promise; /** * Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point. */ validateE911Address(input: AWS.Chime.ValidateE911AddressRequest, options: SdkCallOptions): Promise; } export interface ChimeSDKIdentity { /** * Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity */ createAppInstance(input: AWS.ChimeSDKIdentity.CreateAppInstanceRequest, options: SdkCallOptions): Promise; /** * Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser can be promoted to an AppInstanceAdmin role. */ createAppInstanceAdmin(input: AWS.ChimeSDKIdentity.CreateAppInstanceAdminRequest, options: SdkCallOptions): Promise; /** * Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user. */ createAppInstanceUser(input: AWS.ChimeSDKIdentity.CreateAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Deletes an AppInstance and all associated data asynchronously. */ deleteAppInstance(input: AWS.ChimeSDKIdentity.DeleteAppInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user. */ deleteAppInstanceAdmin(input: AWS.ChimeSDKIdentity.DeleteAppInstanceAdminRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an AppInstanceUser. */ deleteAppInstanceUser(input: AWS.ChimeSDKIdentity.DeleteAppInstanceUserRequest, options: SdkCallOptions): Promise<{}>; /** * Deregisters an AppInstanceUserEndpoint. */ deregisterAppInstanceUserEndpoint(input: AWS.ChimeSDKIdentity.DeregisterAppInstanceUserEndpointRequest, options: SdkCallOptions): Promise<{}>; /** * Returns the full details of an AppInstance. */ describeAppInstance(input: AWS.ChimeSDKIdentity.DescribeAppInstanceRequest, options: SdkCallOptions): Promise; /** * Returns the full details of an AppInstanceAdmin. */ describeAppInstanceAdmin(input: AWS.ChimeSDKIdentity.DescribeAppInstanceAdminRequest, options: SdkCallOptions): Promise; /** * Returns the full details of an AppInstanceUser. */ describeAppInstanceUser(input: AWS.ChimeSDKIdentity.DescribeAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Returns the full details of an AppInstanceUserEndpoint. */ describeAppInstanceUserEndpoint(input: AWS.ChimeSDKIdentity.DescribeAppInstanceUserEndpointRequest, options: SdkCallOptions): Promise; /** * Gets the retention settings for an AppInstance. */ getAppInstanceRetentionSettings(input: AWS.ChimeSDKIdentity.GetAppInstanceRetentionSettingsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the administrators in the AppInstance. */ listAppInstanceAdmins(input: AWS.ChimeSDKIdentity.ListAppInstanceAdminsRequest, options: SdkCallOptions): Promise; /** * Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser. */ listAppInstanceUserEndpoints(input: AWS.ChimeSDKIdentity.ListAppInstanceUserEndpointsRequest, options: SdkCallOptions): Promise; /** * List all AppInstanceUsers created under a single AppInstance. */ listAppInstanceUsers(input: AWS.ChimeSDKIdentity.ListAppInstanceUsersRequest, options: SdkCallOptions): Promise; /** * Lists all Amazon Chime AppInstances created under a single AWS account. */ listAppInstances(input: AWS.ChimeSDKIdentity.ListAppInstancesRequest, options: SdkCallOptions): Promise; /** * Lists the tags applied to an Amazon Chime SDK identity resource. */ listTagsForResource(input: AWS.ChimeSDKIdentity.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Sets the amount of time in days that a given AppInstance retains data. */ putAppInstanceRetentionSettings(input: AWS.ChimeSDKIdentity.PutAppInstanceRetentionSettingsRequest, options: SdkCallOptions): Promise; /** * Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user. */ registerAppInstanceUserEndpoint(input: AWS.ChimeSDKIdentity.RegisterAppInstanceUserEndpointRequest, options: SdkCallOptions): Promise; /** * Applies the specified tags to the specified Amazon Chime SDK identity resource. */ tagResource(input: AWS.ChimeSDKIdentity.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the specified Amazon Chime SDK identity resource. */ untagResource(input: AWS.ChimeSDKIdentity.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates AppInstance metadata. */ updateAppInstance(input: AWS.ChimeSDKIdentity.UpdateAppInstanceRequest, options: SdkCallOptions): Promise; /** * Updates the details of an AppInstanceUser. You can update names and metadata. */ updateAppInstanceUser(input: AWS.ChimeSDKIdentity.UpdateAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values. */ updateAppInstanceUserEndpoint(input: AWS.ChimeSDKIdentity.UpdateAppInstanceUserEndpointRequest, options: SdkCallOptions): Promise; } export interface ChimeSDKMediaPipelines { /** * Creates a media pipeline. */ createMediaCapturePipeline(input: AWS.ChimeSDKMediaPipelines.CreateMediaCapturePipelineRequest, options: SdkCallOptions): Promise; /** * Creates a media concatenation pipeline. */ createMediaConcatenationPipeline(input: AWS.ChimeSDKMediaPipelines.CreateMediaConcatenationPipelineRequest, options: SdkCallOptions): Promise; /** * Creates a streaming media pipeline in an Amazon Chime SDK meeting. */ createMediaLiveConnectorPipeline(input: AWS.ChimeSDKMediaPipelines.CreateMediaLiveConnectorPipelineRequest, options: SdkCallOptions): Promise; /** * Deletes the media pipeline. */ deleteMediaCapturePipeline(input: AWS.ChimeSDKMediaPipelines.DeleteMediaCapturePipelineRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the media pipeline. */ deleteMediaPipeline(input: AWS.ChimeSDKMediaPipelines.DeleteMediaPipelineRequest, options: SdkCallOptions): Promise<{}>; /** * Gets an existing media pipeline. */ getMediaCapturePipeline(input: AWS.ChimeSDKMediaPipelines.GetMediaCapturePipelineRequest, options: SdkCallOptions): Promise; /** * Gets an existing media pipeline. */ getMediaPipeline(input: AWS.ChimeSDKMediaPipelines.GetMediaPipelineRequest, options: SdkCallOptions): Promise; /** * Returns a list of media pipelines. */ listMediaCapturePipelines(input: AWS.ChimeSDKMediaPipelines.ListMediaCapturePipelinesRequest, options: SdkCallOptions): Promise; /** * Returns a list of media pipelines. */ listMediaPipelines(input: AWS.ChimeSDKMediaPipelines.ListMediaPipelinesRequest, options: SdkCallOptions): Promise; /** * Lists the tags available for a media pipeline. */ listTagsForResource(input: AWS.ChimeSDKMediaPipelines.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * The ARN of the media pipeline that you want to tag. Consists of he pipeline's endpoint region, resource ID, and pipeline ID. */ tagResource(input: AWS.ChimeSDKMediaPipelines.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes any tags from a media pipeline. */ untagResource(input: AWS.ChimeSDKMediaPipelines.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface ChimeSDKMeetings { /** * Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ batchCreateAttendee(input: AWS.ChimeSDKMeetings.BatchCreateAttendeeRequest, options: SdkCallOptions): Promise; /** * Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table. You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see . When using capabilities, be aware of these corner cases: You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive. When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server. */ batchUpdateAttendeeCapabilitiesExcept(input: AWS.ChimeSDKMeetings.BatchUpdateAttendeeCapabilitiesExceptRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ createAttendee(input: AWS.ChimeSDKMeetings.CreateAttendeeRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ createMeeting(input: AWS.ChimeSDKMeetings.CreateMeetingRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ createMeetingWithAttendees(input: AWS.ChimeSDKMeetings.CreateMeetingWithAttendeesRequest, options: SdkCallOptions): Promise; /** * Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ deleteAttendee(input: AWS.ChimeSDKMeetings.DeleteAttendeeRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ deleteMeeting(input: AWS.ChimeSDKMeetings.DeleteMeetingRequest, options: SdkCallOptions): Promise<{}>; /** * Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ getAttendee(input: AWS.ChimeSDKMeetings.GetAttendeeRequest, options: SdkCallOptions): Promise; /** * Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ getMeeting(input: AWS.ChimeSDKMeetings.GetMeetingRequest, options: SdkCallOptions): Promise; /** * Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. */ listAttendees(input: AWS.ChimeSDKMeetings.ListAttendeesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags available for the specified resource. */ listTagsForResource(input: AWS.ChimeSDKMeetings.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts transcription for the specified meetingId. */ startMeetingTranscription(input: AWS.ChimeSDKMeetings.StartMeetingTranscriptionRequest, options: SdkCallOptions): Promise<{}>; /** * Stops transcription for the specified meetingId. */ stopMeetingTranscription(input: AWS.ChimeSDKMeetings.StopMeetingTranscriptionRequest, options: SdkCallOptions): Promise<{}>; /** * The resource that supports tags. */ tagResource(input: AWS.ChimeSDKMeetings.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag. You can only tag resources that are located in the specified AWS Region for the calling AWS account. Minimum permissions In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions: tag:UntagResource ChimeSDKMeetings:DeleteTags */ untagResource(input: AWS.ChimeSDKMeetings.UntagResourceRequest, options: SdkCallOptions): Promise; /** * The capabilties that you want to update. You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see . When using capabilities, be aware of these corner cases: You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive. When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server. */ updateAttendeeCapabilities(input: AWS.ChimeSDKMeetings.UpdateAttendeeCapabilitiesRequest, options: SdkCallOptions): Promise; } export interface ChimeSDKMessaging { /** * Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API. Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ associateChannelFlow(input: AWS.ChimeSDKMessaging.AssociateChannelFlowRequest, options: SdkCallOptions): Promise<{}>; /** * Adds a specified number of users to a channel. */ batchCreateChannelMembership(input: AWS.ChimeSDKMessaging.BatchCreateChannelMembershipRequest, options: SdkCallOptions): Promise; /** * Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API. You can return one of the following processing responses: Update message content or metadata Deny a message Make no changes to the message */ channelFlowCallback(input: AWS.ChimeSDKMessaging.ChannelFlowCallbackRequest, options: SdkCallOptions): Promise; /** * Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannel(input: AWS.ChimeSDKMessaging.CreateChannelRequest, options: SdkCallOptions): Promise; /** * Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelBan(input: AWS.ChimeSDKMessaging.CreateChannelBanRequest, options: SdkCallOptions): Promise; /** * Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API. Channel flows process the following items: New and updated messages Persistent and non-persistent messages The Standard message type Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide. */ createChannelFlow(input: AWS.ChimeSDKMessaging.CreateChannelFlowRequest, options: SdkCallOptions): Promise; /** * Adds a user to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can: List messages Send messages Receive messages Edit their own messages Leave the channel Privacy settings impact this action as follows: Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelMembership(input: AWS.ChimeSDKMessaging.CreateChannelMembershipRequest, options: SdkCallOptions): Promise; /** * Creates a new ChannelModerator. A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelModerator(input: AWS.ChimeSDKMessaging.CreateChannelModeratorRequest, options: SdkCallOptions): Promise; /** * Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannel(input: AWS.ChimeSDKMessaging.DeleteChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Removes a user from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelBan(input: AWS.ChimeSDKMessaging.DeleteChannelBanRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a channel flow, an irreversible process. This is a developer API. This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels. */ deleteChannelFlow(input: AWS.ChimeSDKMessaging.DeleteChannelFlowRequest, options: SdkCallOptions): Promise<{}>; /** * Removes a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelMembership(input: AWS.ChimeSDKMessaging.DeleteChannelMembershipRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelMessage(input: AWS.ChimeSDKMessaging.DeleteChannelMessageRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelModerator(input: AWS.ChimeSDKMessaging.DeleteChannelModeratorRequest, options: SdkCallOptions): Promise<{}>; /** * Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannel(input: AWS.ChimeSDKMessaging.DescribeChannelRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelBan(input: AWS.ChimeSDKMessaging.DescribeChannelBanRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API. */ describeChannelFlow(input: AWS.ChimeSDKMessaging.DescribeChannelFlowRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelMembership(input: AWS.ChimeSDKMessaging.DescribeChannelMembershipRequest, options: SdkCallOptions): Promise; /** * Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelMembershipForAppInstanceUser(input: AWS.ChimeSDKMessaging.DescribeChannelMembershipForAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelModeratedByAppInstanceUser(input: AWS.ChimeSDKMessaging.DescribeChannelModeratedByAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelModerator(input: AWS.ChimeSDKMessaging.DescribeChannelModeratorRequest, options: SdkCallOptions): Promise; /** * Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor. Only administrators or channel moderators can disassociate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ disassociateChannelFlow(input: AWS.ChimeSDKMessaging.DisassociateChannelFlowRequest, options: SdkCallOptions): Promise<{}>; /** * Gets the membership preferences of an AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users. Banned users can't retrieve membership preferences for the channel from which they are banned. */ getChannelMembershipPreferences(input: AWS.ChimeSDKMessaging.GetChannelMembershipPreferencesRequest, options: SdkCallOptions): Promise; /** * Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ getChannelMessage(input: AWS.ChimeSDKMessaging.GetChannelMessageRequest, options: SdkCallOptions): Promise; /** * Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket. Messages can have any one of these statuses. SENT Message processed successfully PENDING Ongoing processing FAILED Processing failed DENIED Messasge denied by the processor This API does not return statuses for denied messages, because we don't store them once the processor denies them. Only the message sender can invoke this API. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header */ getChannelMessageStatus(input: AWS.ChimeSDKMessaging.GetChannelMessageStatusRequest, options: SdkCallOptions): Promise; /** * The details of the endpoint for the messaging session. */ getMessagingSessionEndpoint(input: AWS.ChimeSDKMessaging.GetMessagingSessionEndpointRequest, options: SdkCallOptions): Promise; /** * Lists all the users banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelBans(input: AWS.ChimeSDKMessaging.ListChannelBansRequest, options: SdkCallOptions): Promise; /** * Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API. */ listChannelFlows(input: AWS.ChimeSDKMessaging.ListChannelFlowsRequest, options: SdkCallOptions): Promise; /** * Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API. */ listChannelMemberships(input: AWS.ChimeSDKMessaging.ListChannelMembershipsRequest, options: SdkCallOptions): Promise; /** * Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMembershipsForAppInstanceUser(input: AWS.ChimeSDKMessaging.ListChannelMembershipsForAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order. Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMessages(input: AWS.ChimeSDKMessaging.ListChannelMessagesRequest, options: SdkCallOptions): Promise; /** * Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelModerators(input: AWS.ChimeSDKMessaging.ListChannelModeratorsRequest, options: SdkCallOptions): Promise; /** * Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality & restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannels(input: AWS.ChimeSDKMessaging.ListChannelsRequest, options: SdkCallOptions): Promise; /** * Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API. */ listChannelsAssociatedWithChannelFlow(input: AWS.ChimeSDKMessaging.ListChannelsAssociatedWithChannelFlowRequest, options: SdkCallOptions): Promise; /** * A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelsModeratedByAppInstanceUser(input: AWS.ChimeSDKMessaging.ListChannelsModeratedByAppInstanceUserRequest, options: SdkCallOptions): Promise; /** * Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels. */ listSubChannels(input: AWS.ChimeSDKMessaging.ListSubChannelsRequest, options: SdkCallOptions): Promise; /** * Lists the tags applied to an Amazon Chime SDK messaging resource. */ listTagsForResource(input: AWS.ChimeSDKMessaging.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Sets the membership preferences of an AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users can't set membership preferences for the channel from which they are banned. */ putChannelMembershipPreferences(input: AWS.ChimeSDKMessaging.PutChannelMembershipPreferencesRequest, options: SdkCallOptions): Promise; /** * Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ redactChannelMessage(input: AWS.ChimeSDKMessaging.RedactChannelMessageRequest, options: SdkCallOptions): Promise; /** * Allows an AppInstanceUser to search the channels that they belong to. The AppInstanceUser can search by membership or external ID. An AppInstanceAdmin can search across all channels within the AppInstance. */ searchChannels(input: AWS.ChimeSDKMessaging.SearchChannelsRequest, options: SdkCallOptions): Promise; /** * Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata. */ sendChannelMessage(input: AWS.ChimeSDKMessaging.SendChannelMessageRequest, options: SdkCallOptions): Promise; /** * Applies the specified tags to the specified Amazon Chime SDK messaging resource. */ tagResource(input: AWS.ChimeSDKMessaging.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the specified Amazon Chime SDK messaging resource. */ untagResource(input: AWS.ChimeSDKMessaging.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannel(input: AWS.ChimeSDKMessaging.UpdateChannelRequest, options: SdkCallOptions): Promise; /** * Updates channel flow attributes. This is a developer API. */ updateChannelFlow(input: AWS.ChimeSDKMessaging.UpdateChannelFlowRequest, options: SdkCallOptions): Promise; /** * Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannelMessage(input: AWS.ChimeSDKMessaging.UpdateChannelMessageRequest, options: SdkCallOptions): Promise; /** * The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannelReadMarker(input: AWS.ChimeSDKMessaging.UpdateChannelReadMarkerRequest, options: SdkCallOptions): Promise; } export interface Cloud9 { /** * Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment. */ createEnvironmentEC2(input: AWS.Cloud9.CreateEnvironmentEC2Request, options: SdkCallOptions): Promise; /** * Adds an environment member to an Cloud9 development environment. */ createEnvironmentMembership(input: AWS.Cloud9.CreateEnvironmentMembershipRequest, options: SdkCallOptions): Promise; /** * Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. */ deleteEnvironment(input: AWS.Cloud9.DeleteEnvironmentRequest, options: SdkCallOptions): Promise; /** * Deletes an environment member from an Cloud9 development environment. */ deleteEnvironmentMembership(input: AWS.Cloud9.DeleteEnvironmentMembershipRequest, options: SdkCallOptions): Promise; /** * Gets information about environment members for an Cloud9 development environment. */ describeEnvironmentMemberships(input: AWS.Cloud9.DescribeEnvironmentMembershipsRequest, options: SdkCallOptions): Promise; /** * Gets status information for an Cloud9 development environment. */ describeEnvironmentStatus(input: AWS.Cloud9.DescribeEnvironmentStatusRequest, options: SdkCallOptions): Promise; /** * Gets information about Cloud9 development environments. */ describeEnvironments(input: AWS.Cloud9.DescribeEnvironmentsRequest, options: SdkCallOptions): Promise; /** * Gets a list of Cloud9 development environment identifiers. */ listEnvironments(input: AWS.Cloud9.ListEnvironmentsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the tags associated with an Cloud9 development environment. */ listTagsForResource(input: AWS.Cloud9.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds tags to an Cloud9 development environment. Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to underlying resources. */ tagResource(input: AWS.Cloud9.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from an Cloud9 development environment. */ untagResource(input: AWS.Cloud9.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Changes the settings of an existing Cloud9 development environment. */ updateEnvironment(input: AWS.Cloud9.UpdateEnvironmentRequest, options: SdkCallOptions): Promise; /** * Changes the settings of an existing environment member for an Cloud9 development environment. */ updateEnvironmentMembership(input: AWS.Cloud9.UpdateEnvironmentMembershipRequest, options: SdkCallOptions): Promise; } export interface CloudControl { /** * Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide. Only resource operations requests with a status of PENDING or IN_PROGRESS can be canceled. */ cancelResourceRequest(input: AWS.CloudControl.CancelResourceRequestInput, options: SdkCallOptions): Promise; /** * Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide. After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent type returned by CreateResource. */ createResource(input: AWS.CloudControl.CreateResourceInput, options: SdkCallOptions): Promise; /** * Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide. After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource. */ deleteResource(input: AWS.CloudControl.DeleteResourceInput, options: SdkCallOptions): Promise; /** * Returns information about the current state of the specified resource. For details, see Reading a resource's current state. You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API. */ getResource(input: AWS.CloudControl.GetResourceInput, options: SdkCallOptions): Promise; /** * Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide. */ getResourceRequestStatus(input: AWS.CloudControl.GetResourceRequestStatusInput, options: SdkCallOptions): Promise; /** * Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide. Resource operation requests expire after 7 days. */ listResourceRequests(input: AWS.CloudControl.ListResourceRequestsInput, options: SdkCallOptions): Promise; /** * Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide. You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API. */ listResources(input: AWS.CloudControl.ListResourcesInput, options: SdkCallOptions): Promise; /** * Updates the specified property values in the resource. You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch standard. For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide. After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by UpdateResource. For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide. */ updateResource(input: AWS.CloudControl.UpdateResourceInput, options: SdkCallOptions): Promise; } export interface CloudDirectory { /** * Adds a new Facet to an object. An object can have more than one facet applied on it. */ addFacetToObject(input: AWS.CloudDirectory.AddFacetToObjectRequest, options: SdkCallOptions): Promise; /** * Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema. */ applySchema(input: AWS.CloudDirectory.ApplySchemaRequest, options: SdkCallOptions): Promise; /** * Attaches an existing object to another object. An object can be accessed in two ways: Using the path Using ObjectIdentifier */ attachObject(input: AWS.CloudDirectory.AttachObjectRequest, options: SdkCallOptions): Promise; /** * Attaches a policy object to a regular object. An object can have a limited number of attached policies. */ attachPolicy(input: AWS.CloudDirectory.AttachPolicyRequest, options: SdkCallOptions): Promise; /** * Attaches the specified object to the specified index. */ attachToIndex(input: AWS.CloudDirectory.AttachToIndexRequest, options: SdkCallOptions): Promise; /** * Attaches a typed link to a specified source and target object. For more information, see Typed Links. */ attachTypedLink(input: AWS.CloudDirectory.AttachTypedLinkRequest, options: SdkCallOptions): Promise; /** * Performs all the read operations in a batch. */ batchRead(input: AWS.CloudDirectory.BatchReadRequest, options: SdkCallOptions): Promise; /** * Performs all the write operations in a batch. Either all the operations succeed or none. */ batchWrite(input: AWS.CloudDirectory.BatchWriteRequest, options: SdkCallOptions): Promise; /** * Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema. You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide. */ createDirectory(input: AWS.CloudDirectory.CreateDirectoryRequest, options: SdkCallOptions): Promise; /** * Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas. */ createFacet(input: AWS.CloudDirectory.CreateFacetRequest, options: SdkCallOptions): Promise; /** * Creates an index object. See Indexing and search for more information. */ createIndex(input: AWS.CloudDirectory.CreateIndexRequest, options: SdkCallOptions): Promise; /** * Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. */ createObject(input: AWS.CloudDirectory.CreateObjectRequest, options: SdkCallOptions): Promise; /** * Creates a new schema in a development state. A schema can exist in three phases: Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published. Published: Published schemas are immutable and have a version associated with them. Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories. */ createSchema(input: AWS.CloudDirectory.CreateSchemaRequest, options: SdkCallOptions): Promise; /** * Creates a TypedLinkFacet. For more information, see Typed Links. */ createTypedLinkFacet(input: AWS.CloudDirectory.CreateTypedLinkFacetRequest, options: SdkCallOptions): Promise; /** * Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories. */ deleteDirectory(input: AWS.CloudDirectory.DeleteDirectoryRequest, options: SdkCallOptions): Promise; /** * Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion. */ deleteFacet(input: AWS.CloudDirectory.DeleteFacetRequest, options: SdkCallOptions): Promise; /** * Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits. */ deleteObject(input: AWS.CloudDirectory.DeleteObjectRequest, options: SdkCallOptions): Promise; /** * Deletes a given schema. Schemas in a development and published state can only be deleted. */ deleteSchema(input: AWS.CloudDirectory.DeleteSchemaRequest, options: SdkCallOptions): Promise; /** * Deletes a TypedLinkFacet. For more information, see Typed Links. */ deleteTypedLinkFacet(input: AWS.CloudDirectory.DeleteTypedLinkFacetRequest, options: SdkCallOptions): Promise; /** * Detaches the specified object from the specified index. */ detachFromIndex(input: AWS.CloudDirectory.DetachFromIndexRequest, options: SdkCallOptions): Promise; /** * Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name. */ detachObject(input: AWS.CloudDirectory.DetachObjectRequest, options: SdkCallOptions): Promise; /** * Detaches a policy from an object. */ detachPolicy(input: AWS.CloudDirectory.DetachPolicyRequest, options: SdkCallOptions): Promise; /** * Detaches a typed link from a specified source and target object. For more information, see Typed Links. */ detachTypedLink(input: AWS.CloudDirectory.DetachTypedLinkRequest, options: SdkCallOptions): Promise<{}>; /** * Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled. */ disableDirectory(input: AWS.CloudDirectory.DisableDirectoryRequest, options: SdkCallOptions): Promise; /** * Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to. */ enableDirectory(input: AWS.CloudDirectory.EnableDirectoryRequest, options: SdkCallOptions): Promise; /** * Returns current applied schema version ARN, including the minor version in use. */ getAppliedSchemaVersion(input: AWS.CloudDirectory.GetAppliedSchemaVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves metadata about a directory. */ getDirectory(input: AWS.CloudDirectory.GetDirectoryRequest, options: SdkCallOptions): Promise; /** * Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied. */ getFacet(input: AWS.CloudDirectory.GetFacetRequest, options: SdkCallOptions): Promise; /** * Retrieves attributes that are associated with a typed link. */ getLinkAttributes(input: AWS.CloudDirectory.GetLinkAttributesRequest, options: SdkCallOptions): Promise; /** * Retrieves attributes within a facet that are associated with an object. */ getObjectAttributes(input: AWS.CloudDirectory.GetObjectAttributesRequest, options: SdkCallOptions): Promise; /** * Retrieves metadata about an object. */ getObjectInformation(input: AWS.CloudDirectory.GetObjectInformationRequest, options: SdkCallOptions): Promise; /** * Retrieves a JSON representation of the schema. See JSON Schema Format for more information. */ getSchemaAsJson(input: AWS.CloudDirectory.GetSchemaAsJsonRequest, options: SdkCallOptions): Promise; /** * Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links. */ getTypedLinkFacetInformation(input: AWS.CloudDirectory.GetTypedLinkFacetInformationRequest, options: SdkCallOptions): Promise; /** * Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version. */ listAppliedSchemaArns(input: AWS.CloudDirectory.ListAppliedSchemaArnsRequest, options: SdkCallOptions): Promise; /** * Lists indices attached to the specified object. */ listAttachedIndices(input: AWS.CloudDirectory.ListAttachedIndicesRequest, options: SdkCallOptions): Promise; /** * Retrieves each Amazon Resource Name (ARN) of schemas in the development state. */ listDevelopmentSchemaArns(input: AWS.CloudDirectory.ListDevelopmentSchemaArnsRequest, options: SdkCallOptions): Promise; /** * Lists directories created within an account. */ listDirectories(input: AWS.CloudDirectory.ListDirectoriesRequest, options: SdkCallOptions): Promise; /** * Retrieves attributes attached to the facet. */ listFacetAttributes(input: AWS.CloudDirectory.ListFacetAttributesRequest, options: SdkCallOptions): Promise; /** * Retrieves the names of facets that exist in a schema. */ listFacetNames(input: AWS.CloudDirectory.ListFacetNamesRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. */ listIncomingTypedLinks(input: AWS.CloudDirectory.ListIncomingTypedLinksRequest, options: SdkCallOptions): Promise; /** * Lists objects attached to the specified index. */ listIndex(input: AWS.CloudDirectory.ListIndexRequest, options: SdkCallOptions): Promise; /** * Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead. */ listManagedSchemaArns(input: AWS.CloudDirectory.ListManagedSchemaArnsRequest, options: SdkCallOptions): Promise; /** * Lists all attributes that are associated with an object. */ listObjectAttributes(input: AWS.CloudDirectory.ListObjectAttributesRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of child objects that are associated with a given object. */ listObjectChildren(input: AWS.CloudDirectory.ListObjectChildrenRequest, options: SdkCallOptions): Promise; /** * Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure. Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object. */ listObjectParentPaths(input: AWS.CloudDirectory.ListObjectParentPathsRequest, options: SdkCallOptions): Promise; /** * Lists parent objects that are associated with a given object in pagination fashion. */ listObjectParents(input: AWS.CloudDirectory.ListObjectParentsRequest, options: SdkCallOptions): Promise; /** * Returns policies attached to an object in pagination fashion. */ listObjectPolicies(input: AWS.CloudDirectory.ListObjectPoliciesRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links. */ listOutgoingTypedLinks(input: AWS.CloudDirectory.ListOutgoingTypedLinksRequest, options: SdkCallOptions): Promise; /** * Returns all of the ObjectIdentifiers to which a given policy is attached. */ listPolicyAttachments(input: AWS.CloudDirectory.ListPolicyAttachmentsRequest, options: SdkCallOptions): Promise; /** * Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead. */ listPublishedSchemaArns(input: AWS.CloudDirectory.ListPublishedSchemaArnsRequest, options: SdkCallOptions): Promise; /** * Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call. */ listTagsForResource(input: AWS.CloudDirectory.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links. */ listTypedLinkFacetAttributes(input: AWS.CloudDirectory.ListTypedLinkFacetAttributesRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links. */ listTypedLinkFacetNames(input: AWS.CloudDirectory.ListTypedLinkFacetNamesRequest, options: SdkCallOptions): Promise; /** * Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies. */ lookupPolicy(input: AWS.CloudDirectory.LookupPolicyRequest, options: SdkCallOptions): Promise; /** * Publishes a development schema with a major version and a recommended minor version. */ publishSchema(input: AWS.CloudDirectory.PublishSchemaRequest, options: SdkCallOptions): Promise; /** * Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information. */ putSchemaFromJson(input: AWS.CloudDirectory.PutSchemaFromJsonRequest, options: SdkCallOptions): Promise; /** * Removes the specified facet from the specified object. */ removeFacetFromObject(input: AWS.CloudDirectory.RemoveFacetFromObjectRequest, options: SdkCallOptions): Promise; /** * An API operation for adding tags to a resource. */ tagResource(input: AWS.CloudDirectory.TagResourceRequest, options: SdkCallOptions): Promise; /** * An API operation for removing tags from a resource. */ untagResource(input: AWS.CloudDirectory.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Does the following: Adds new Attributes, Rules, or ObjectTypes. Updates existing Attributes, Rules, or ObjectTypes. Deletes existing Attributes, Rules, or ObjectTypes. */ updateFacet(input: AWS.CloudDirectory.UpdateFacetRequest, options: SdkCallOptions): Promise; /** * Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder. */ updateLinkAttributes(input: AWS.CloudDirectory.UpdateLinkAttributesRequest, options: SdkCallOptions): Promise; /** * Updates a given object's attributes. */ updateObjectAttributes(input: AWS.CloudDirectory.UpdateObjectAttributesRequest, options: SdkCallOptions): Promise; /** * Updates the schema name with a new name. Only development schema names can be updated. */ updateSchema(input: AWS.CloudDirectory.UpdateSchemaRequest, options: SdkCallOptions): Promise; /** * Updates a TypedLinkFacet. For more information, see Typed Links. */ updateTypedLinkFacet(input: AWS.CloudDirectory.UpdateTypedLinkFacetRequest, options: SdkCallOptions): Promise; /** * Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory. */ upgradeAppliedSchema(input: AWS.CloudDirectory.UpgradeAppliedSchemaRequest, options: SdkCallOptions): Promise; /** * Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn. */ upgradePublishedSchema(input: AWS.CloudDirectory.UpgradePublishedSchemaRequest, options: SdkCallOptions): Promise; } export interface CloudFormation { /** * Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide. Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide. */ activateType(input: AWS.CloudFormation.ActivateTypeInput, options: SdkCallOptions): Promise; /** * Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region. For more information, see Configuring extensions at the account level in the CloudFormation User Guide. */ batchDescribeTypeConfigurations(input: AWS.CloudFormation.BatchDescribeTypeConfigurationsInput, options: SdkCallOptions): Promise; /** * Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. */ cancelUpdateStack(input: AWS.CloudFormation.CancelUpdateStackInput, options: SdkCallOptions): Promise<{}>; /** * For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. */ continueUpdateRollback(input: AWS.CloudFormation.ContinueUpdateRollbackInput, options: SdkCallOptions): Promise; /** * Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set. To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True. */ createChangeSet(input: AWS.CloudFormation.CreateChangeSetInput, options: SdkCallOptions): Promise; /** * Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacksoperation. */ createStack(input: AWS.CloudFormation.CreateStackInput, options: SdkCallOptions): Promise; /** * Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions. */ createStackInstances(input: AWS.CloudFormation.CreateStackInstancesInput, options: SdkCallOptions): Promise; /** * Creates a stack set. */ createStackSet(input: AWS.CloudFormation.CreateStackSetInput, options: SdkCallOptions): Promise; /** * Deactivates a public extension that was previously activated in this account and region. Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released. */ deactivateType(input: AWS.CloudFormation.DeactivateTypeInput, options: SdkCallOptions): Promise; /** * Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, CloudFormation successfully deleted the change set. If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS. */ deleteChangeSet(input: AWS.CloudFormation.DeleteChangeSetInput, options: SdkCallOptions): Promise; /** * Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully. */ deleteStack(input: AWS.CloudFormation.DeleteStackInput, options: SdkCallOptions): Promise<{}>; /** * Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions. */ deleteStackInstances(input: AWS.CloudFormation.DeleteStackInstancesInput, options: SdkCallOptions): Promise; /** * Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances. */ deleteStackSet(input: AWS.CloudFormation.DeleteStackSetInput, options: SdkCallOptions): Promise; /** * Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations. To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry. You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated. To view the deprecation status of an extension or extension version, use DescribeType. */ deregisterType(input: AWS.CloudFormation.DeregisterTypeInput, options: SdkCallOptions): Promise; /** * Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide. */ describeAccountLimits(input: AWS.CloudFormation.DescribeAccountLimitsInput, options: SdkCallOptions): Promise; /** * Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide. */ describeChangeSet(input: AWS.CloudFormation.DescribeChangeSetInput, options: SdkCallOptions): Promise; /** * Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set. */ describeChangeSetHooks(input: AWS.CloudFormation.DescribeChangeSetHooksInput, options: SdkCallOptions): Promise; /** * Returns information about a CloudFormation extension publisher. If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account. For more information about registering as a publisher, see: RegisterPublisher Publishing extensions to make them available for public use in the CloudFormation CLI User Guide */ describePublisher(input: AWS.CloudFormation.DescribePublisherInput, options: SdkCallOptions): Promise; /** * Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. */ describeStackDriftDetectionStatus(input: AWS.CloudFormation.DescribeStackDriftDetectionStatusInput, options: SdkCallOptions): Promise; /** * Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID). */ describeStackEvents(input: AWS.CloudFormation.DescribeStackEventsInput, options: SdkCallOptions): Promise; /** * Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances. */ describeStackInstance(input: AWS.CloudFormation.DescribeStackInstanceInput, options: SdkCallOptions): Promise; /** * Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. */ describeStackResource(input: AWS.CloudFormation.DescribeStackResourceInput, options: SdkCallOptions): Promise; /** * Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack. */ describeStackResourceDrifts(input: AWS.CloudFormation.DescribeStackResourceDriftsInput, options: SdkCallOptions): Promise; /** * Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned. Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide. A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request. */ describeStackResources(input: AWS.CloudFormation.DescribeStackResourcesInput, options: SdkCallOptions): Promise; /** * Returns the description of the specified stack set. */ describeStackSet(input: AWS.CloudFormation.DescribeStackSetInput, options: SdkCallOptions): Promise; /** * Returns the description of the specified stack set operation. */ describeStackSetOperation(input: AWS.CloudFormation.DescribeStackSetOperationInput, options: SdkCallOptions): Promise; /** * Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. If the stack doesn't exist, an ValidationError is returned. */ describeStacks(input: AWS.CloudFormation.DescribeStacksInput, options: SdkCallOptions): Promise; /** * Returns detailed information about an extension that has been registered. If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version. */ describeType(input: AWS.CloudFormation.DescribeTypeInput, options: SdkCallOptions): Promise; /** * Returns information about an extension's registration, including its current status and type and version identifiers. When you initiate a registration request using RegisterType , you can then use DescribeTypeRegistration to monitor the progress of that registration request. Once the registration request has completed, use DescribeType to return detailed information about an extension. */ describeTypeRegistration(input: AWS.CloudFormation.DescribeTypeRegistrationInput, options: SdkCallOptions): Promise; /** * Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources. For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection. DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself. */ detectStackDrift(input: AWS.CloudFormation.DetectStackDriftInput, options: SdkCallOptions): Promise; /** * Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection. Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection. */ detectStackResourceDrift(input: AWS.CloudFormation.DetectStackResourceDriftInput, options: SdkCallOptions): Promise; /** * Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set. DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack. Once the operation has completed, use the following actions to return drift information: Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.) Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance. Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked. For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets. You can only run a single drift detection operation on a given stack set at one time. To stop a drift detection stack set operation, use StopStackSetOperation . */ detectStackSetDrift(input: AWS.CloudFormation.DetectStackSetDriftInput, options: SdkCallOptions): Promise; /** * Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template. */ estimateTemplateCost(input: AWS.CloudFormation.EstimateTemplateCostInput, options: SdkCallOptions): Promise; /** * Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update. When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy. To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to True. */ executeChangeSet(input: AWS.CloudFormation.ExecuteChangeSetInput, options: SdkCallOptions): Promise; /** * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. */ getStackPolicy(input: AWS.CloudFormation.GetStackPolicyInput, options: SdkCallOptions): Promise; /** * Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned. */ getTemplate(input: AWS.CloudFormation.GetTemplateInput, options: SdkCallOptions): Promise; /** * Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned. */ getTemplateSummary(input: AWS.CloudFormation.GetTemplateSummaryInput, options: SdkCallOptions): Promise; /** * Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import. ImportStacksToStackSet is only supported by self-managed permissions. */ importStacksToStackSet(input: AWS.CloudFormation.ImportStacksToStackSetInput, options: SdkCallOptions): Promise; /** * Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state. */ listChangeSets(input: AWS.CloudFormation.ListChangeSetsInput, options: SdkCallOptions): Promise; /** * Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function. For more information, see CloudFormation export stack output values. */ listExports(input: AWS.CloudFormation.ListExportsInput, options: SdkCallOptions): Promise; /** * Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports. For more information about importing an exported output value, see the Fn::ImportValue function. */ listImports(input: AWS.CloudFormation.ListImportsInput, options: SdkCallOptions): Promise; /** * Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status. */ listStackInstances(input: AWS.CloudFormation.ListStackInstancesInput, options: SdkCallOptions): Promise; /** * Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. */ listStackResources(input: AWS.CloudFormation.ListStackResourcesInput, options: SdkCallOptions): Promise; /** * Returns summary information about the results of a stack set operation. */ listStackSetOperationResults(input: AWS.CloudFormation.ListStackSetOperationResultsInput, options: SdkCallOptions): Promise; /** * Returns summary information about operations performed on a stack set. */ listStackSetOperations(input: AWS.CloudFormation.ListStackSetOperationsInput, options: SdkCallOptions): Promise; /** * Returns summary information about stack sets that are associated with the user. [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account. [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account. [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account. */ listStackSets(input: AWS.CloudFormation.ListStackSetsInput, options: SdkCallOptions): Promise; /** * Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). */ listStacks(input: AWS.CloudFormation.ListStacksInput, options: SdkCallOptions): Promise; /** * Returns a list of registration tokens for the specified extension(s). */ listTypeRegistrations(input: AWS.CloudFormation.ListTypeRegistrationsInput, options: SdkCallOptions): Promise; /** * Returns summary information about the versions of an extension. */ listTypeVersions(input: AWS.CloudFormation.ListTypeVersionsInput, options: SdkCallOptions): Promise; /** * Returns summary information about extension that have been registered with CloudFormation. */ listTypes(input: AWS.CloudFormation.ListTypesInput, options: SdkCallOptions): Promise; /** * Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide. To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher. */ publishType(input: AWS.CloudFormation.PublishTypeInput, options: SdkCallOptions): Promise; /** * Reports progress of a resource handler to CloudFormation. Reserved for use by the CloudFormation CLI. Don't use this API in your code. */ recordHandlerProgress(input: AWS.CloudFormation.RecordHandlerProgressInput, options: SdkCallOptions): Promise; /** * Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions. For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide. */ registerPublisher(input: AWS.CloudFormation.RegisterPublisherInput, options: SdkCallOptions): Promise; /** * Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes: Validating the extension schema. Determining which handlers, if any, have been specified for the extension. Making the extension available for use in your account. For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide. You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary. Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request. Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide. */ registerType(input: AWS.CloudFormation.RegisterTypeInput, options: SdkCallOptions): Promise; /** * When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation. Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses. This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses. CREATE_COMPLETE UPDATE_COMPLETE UPDATE_ROLLBACK_COMPLETE IMPORT_COMPLETE IMPORT_ROLLBACK_COMPLETE */ rollbackStack(input: AWS.CloudFormation.RollbackStackInput, options: SdkCallOptions): Promise; /** * Sets a stack policy for a specified stack. */ setStackPolicy(input: AWS.CloudFormation.SetStackPolicyInput, options: SdkCallOptions): Promise<{}>; /** * Specifies the configuration data for a registered CloudFormation extension, in the given account and region. To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide. It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide. */ setTypeConfiguration(input: AWS.CloudFormation.SetTypeConfigurationInput, options: SdkCallOptions): Promise; /** * Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations. */ setTypeDefaultVersion(input: AWS.CloudFormation.SetTypeDefaultVersionInput, options: SdkCallOptions): Promise; /** * Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. */ signalResource(input: AWS.CloudFormation.SignalResourceInput, options: SdkCallOptions): Promise<{}>; /** * Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete. */ stopStackSetOperation(input: AWS.CloudFormation.StopStackSetOperationInput, options: SdkCallOptions): Promise; /** * Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. For resource types, this includes passing all contracts tests defined for the type. For modules, this includes determining if the module's model meets all necessary requirements. For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide. If you don't specify a version, CloudFormation uses the default version of the extension in your account and region for testing. To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType. Once you've initiated testing on an extension using TestType, you can use DescribeType to monitor the current test status and test status description for the extension. An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide. */ testType(input: AWS.CloudFormation.TestTypeInput, options: SdkCallOptions): Promise; /** * Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack. */ updateStack(input: AWS.CloudFormation.UpdateStackInput, options: SdkCallOptions): Promise; /** * Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances. During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value. You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances. */ updateStackInstances(input: AWS.CloudFormation.UpdateStackInstancesInput, options: SdkCallOptions): Promise; /** * Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set. */ updateStackSet(input: AWS.CloudFormation.UpdateStackSetInput, options: SdkCallOptions): Promise; /** * Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. */ updateTerminationProtection(input: AWS.CloudFormation.UpdateTerminationProtectionInput, options: SdkCallOptions): Promise; /** * Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error. */ validateTemplate(input: AWS.CloudFormation.ValidateTemplateInput, options: SdkCallOptions): Promise; } export interface CloudFront { /** * Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution. With this operation you can move an alias that’s already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution. To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide. */ associateAlias(input: AWS.CloudFront.AssociateAliasRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a cache policy. After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following: The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer. The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache. The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy. For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide. */ createCachePolicy(input: AWS.CloudFront.CreateCachePolicyRequest, options: SdkCallOptions): Promise; /** * Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide. */ createCloudFrontOriginAccessIdentity(input: AWS.CloudFront.CreateCloudFrontOriginAccessIdentityRequest, options: SdkCallOptions): Promise; /** * Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource. When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide. */ createDistribution(input: AWS.CloudFront.CreateDistributionRequest, options: SdkCallOptions): Promise; /** * Create a new distribution with tags. */ createDistributionWithTags(input: AWS.CloudFront.CreateDistributionWithTagsRequest, options: SdkCallOptions): Promise; /** * Create a new field-level encryption configuration. */ createFieldLevelEncryptionConfig(input: AWS.CloudFront.CreateFieldLevelEncryptionConfigRequest, options: SdkCallOptions): Promise; /** * Create a field-level encryption profile. */ createFieldLevelEncryptionProfile(input: AWS.CloudFront.CreateFieldLevelEncryptionProfileRequest, options: SdkCallOptions): Promise; /** * Creates a CloudFront function. To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function. When you create a function, it’s in the DEVELOPMENT stage. In this stage, you can test the function with TestFunction, and update it with UpdateFunction. When you’re ready to use your function with a CloudFront distribution, use PublishFunction to copy the function from the DEVELOPMENT stage to LIVE. When it’s live, you can attach the function to a distribution’s cache behavior, using the function’s ARN. */ createFunction(input: AWS.CloudFront.CreateFunctionRequest, options: SdkCallOptions): Promise; /** * Create a new invalidation. */ createInvalidation(input: AWS.CloudFront.CreateInvalidationRequest, options: SdkCallOptions): Promise; /** * Creates a key group that you can use with CloudFront signed URLs and signed cookies. To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide. */ createKeyGroup(input: AWS.CloudFront.CreateKeyGroupRequest, options: SdkCallOptions): Promise; /** * Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost. For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide. */ createMonitoringSubscription(input: AWS.CloudFront.CreateMonitoringSubscriptionRequest, options: SdkCallOptions): Promise; /** * Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin. For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket so that viewers (users) can access the content in the bucket only through CloudFront. For more information about using a CloudFront origin access control, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide. */ createOriginAccessControl(input: AWS.CloudFront.CreateOriginAccessControlRequest, options: SdkCallOptions): Promise; /** * Creates an origin request policy. After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following: The request body and the URL path (without the domain name) from the viewer request. The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id. All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront. CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy. For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide. */ createOriginRequestPolicy(input: AWS.CloudFront.CreateOriginRequestPolicyRequest, options: SdkCallOptions): Promise; /** * Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption. */ createPublicKey(input: AWS.CloudFront.CreatePublicKeyRequest, options: SdkCallOptions): Promise; /** * Creates a real-time log configuration. After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream. For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide. */ createRealtimeLogConfig(input: AWS.CloudFront.CreateRealtimeLogConfigRequest, options: SdkCallOptions): Promise; /** * Creates a response headers policy. A response headers policy contains information about a set of HTTP response headers and their values. To create a response headers policy, you provide some metadata about the policy, and a set of configurations that specify the response headers. After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it’s attached to a cache behavior, CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match the cache behavior. */ createResponseHeadersPolicy(input: AWS.CloudFront.CreateResponseHeadersPolicyRequest, options: SdkCallOptions): Promise; /** * This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum. */ createStreamingDistribution(input: AWS.CloudFront.CreateStreamingDistributionRequest, options: SdkCallOptions): Promise; /** * This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum. */ createStreamingDistributionWithTags(input: AWS.CloudFront.CreateStreamingDistributionWithTagsRequest, options: SdkCallOptions): Promise; /** * Deletes a cache policy. You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy. To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use ListCachePolicies or GetCachePolicy. */ deleteCachePolicy(input: AWS.CloudFront.DeleteCachePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Delete an origin access identity. */ deleteCloudFrontOriginAccessIdentity(input: AWS.CloudFront.DeleteCloudFrontOriginAccessIdentityRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a distribution. */ deleteDistribution(input: AWS.CloudFront.DeleteDistributionRequest, options: SdkCallOptions): Promise<{}>; /** * Remove a field-level encryption configuration. */ deleteFieldLevelEncryptionConfig(input: AWS.CloudFront.DeleteFieldLevelEncryptionConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Remove a field-level encryption profile. */ deleteFieldLevelEncryptionProfile(input: AWS.CloudFront.DeleteFieldLevelEncryptionProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a CloudFront function. You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function. To delete a function, you must provide the function’s name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction. */ deleteFunction(input: AWS.CloudFront.DeleteFunctionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a key group. You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group. To delete a key group, you must provide the key group’s identifier and version. To get these values, use ListKeyGroups followed by GetKeyGroup or GetKeyGroupConfig. */ deleteKeyGroup(input: AWS.CloudFront.DeleteKeyGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Disables additional CloudWatch metrics for the specified CloudFront distribution. */ deleteMonitoringSubscription(input: AWS.CloudFront.DeleteMonitoringSubscriptionRequest, options: SdkCallOptions): Promise; /** * Deletes a CloudFront origin access control. You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control. */ deleteOriginAccessControl(input: AWS.CloudFront.DeleteOriginAccessControlRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an origin request policy. You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy. To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier, you can use ListOriginRequestPolicies or GetOriginRequestPolicy. */ deleteOriginRequestPolicy(input: AWS.CloudFront.DeleteOriginRequestPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Remove a public key you previously added to CloudFront. */ deletePublicKey(input: AWS.CloudFront.DeletePublicKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a real-time log configuration. You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration. To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete. */ deleteRealtimeLogConfig(input: AWS.CloudFront.DeleteRealtimeLogConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a response headers policy. You cannot delete a response headers policy if it’s attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy. To delete a response headers policy, you must provide the policy’s identifier and version. To get these values, you can use ListResponseHeadersPolicies or GetResponseHeadersPolicy. */ deleteResponseHeadersPolicy(input: AWS.CloudFront.DeleteResponseHeadersPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps. To delete an RTMP distribution using the CloudFront API: Disable the RTMP distribution. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted. For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide. */ deleteStreamingDistribution(input: AWS.CloudFront.DeleteStreamingDistributionRequest, options: SdkCallOptions): Promise<{}>; /** * Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a function’s code, use GetFunction. To get configuration information and metadata about a function, you must provide the function’s name and stage. To get these values, you can use ListFunctions. */ describeFunction(input: AWS.CloudFront.DescribeFunctionRequest, options: SdkCallOptions): Promise; /** * Gets a cache policy, including the following metadata: The policy’s identifier. The date and time when the policy was last modified. To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies. */ getCachePolicy(input: AWS.CloudFront.GetCachePolicyRequest, options: SdkCallOptions): Promise; /** * Gets a cache policy configuration. To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies. */ getCachePolicyConfig(input: AWS.CloudFront.GetCachePolicyConfigRequest, options: SdkCallOptions): Promise; /** * Get the information about an origin access identity. */ getCloudFrontOriginAccessIdentity(input: AWS.CloudFront.GetCloudFrontOriginAccessIdentityRequest, options: SdkCallOptions): Promise; /** * Get the configuration information about an origin access identity. */ getCloudFrontOriginAccessIdentityConfig(input: AWS.CloudFront.GetCloudFrontOriginAccessIdentityConfigRequest, options: SdkCallOptions): Promise; /** * Get the information about a distribution. */ getDistribution(input: AWS.CloudFront.GetDistributionRequest, options: SdkCallOptions): Promise; /** * Get the configuration information about a distribution. */ getDistributionConfig(input: AWS.CloudFront.GetDistributionConfigRequest, options: SdkCallOptions): Promise; /** * Get the field-level encryption configuration information. */ getFieldLevelEncryption(input: AWS.CloudFront.GetFieldLevelEncryptionRequest, options: SdkCallOptions): Promise; /** * Get the field-level encryption configuration information. */ getFieldLevelEncryptionConfig(input: AWS.CloudFront.GetFieldLevelEncryptionConfigRequest, options: SdkCallOptions): Promise; /** * Get the field-level encryption profile information. */ getFieldLevelEncryptionProfile(input: AWS.CloudFront.GetFieldLevelEncryptionProfileRequest, options: SdkCallOptions): Promise; /** * Get the field-level encryption profile configuration information. */ getFieldLevelEncryptionProfileConfig(input: AWS.CloudFront.GetFieldLevelEncryptionProfileConfigRequest, options: SdkCallOptions): Promise; /** * Gets the code of a CloudFront function. To get configuration information and metadata about a function, use DescribeFunction. To get a function’s code, you must provide the function’s name and stage. To get these values, you can use ListFunctions. */ getFunction(input: AWS.CloudFront.GetFunctionRequest, options: SdkCallOptions): Promise; /** * Get the information about an invalidation. */ getInvalidation(input: AWS.CloudFront.GetInvalidationRequest, options: SdkCallOptions): Promise; /** * Gets a key group, including the date and time when the key group was last modified. To get a key group, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups. */ getKeyGroup(input: AWS.CloudFront.GetKeyGroupRequest, options: SdkCallOptions): Promise; /** * Gets a key group configuration. To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups. */ getKeyGroupConfig(input: AWS.CloudFront.GetKeyGroupConfigRequest, options: SdkCallOptions): Promise; /** * Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution. */ getMonitoringSubscription(input: AWS.CloudFront.GetMonitoringSubscriptionRequest, options: SdkCallOptions): Promise; /** * Gets a CloudFront origin access control, including its unique identifier. */ getOriginAccessControl(input: AWS.CloudFront.GetOriginAccessControlRequest, options: SdkCallOptions): Promise; /** * Gets a CloudFront origin access control configuration. */ getOriginAccessControlConfig(input: AWS.CloudFront.GetOriginAccessControlConfigRequest, options: SdkCallOptions): Promise; /** * Gets an origin request policy, including the following metadata: The policy’s identifier. The date and time when the policy was last modified. To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies. */ getOriginRequestPolicy(input: AWS.CloudFront.GetOriginRequestPolicyRequest, options: SdkCallOptions): Promise; /** * Gets an origin request policy configuration. To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies. */ getOriginRequestPolicyConfig(input: AWS.CloudFront.GetOriginRequestPolicyConfigRequest, options: SdkCallOptions): Promise; /** * Gets a public key. */ getPublicKey(input: AWS.CloudFront.GetPublicKeyRequest, options: SdkCallOptions): Promise; /** * Gets a public key configuration. */ getPublicKeyConfig(input: AWS.CloudFront.GetPublicKeyConfigRequest, options: SdkCallOptions): Promise; /** * Gets a real-time log configuration. To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get. */ getRealtimeLogConfig(input: AWS.CloudFront.GetRealtimeLogConfigRequest, options: SdkCallOptions): Promise; /** * Gets a response headers policy, including metadata (the policy’s identifier and the date and time when the policy was last modified). To get a response headers policy, you must provide the policy’s identifier. If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies. */ getResponseHeadersPolicy(input: AWS.CloudFront.GetResponseHeadersPolicyRequest, options: SdkCallOptions): Promise; /** * Gets a response headers policy configuration. To get a response headers policy configuration, you must provide the policy’s identifier. If the response headers policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies. */ getResponseHeadersPolicyConfig(input: AWS.CloudFront.GetResponseHeadersPolicyConfigRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified RTMP distribution, including the distribution configuration. */ getStreamingDistribution(input: AWS.CloudFront.GetStreamingDistributionRequest, options: SdkCallOptions): Promise; /** * Get the configuration information about a streaming distribution. */ getStreamingDistributionConfig(input: AWS.CloudFront.GetStreamingDistributionConfigRequest, options: SdkCallOptions): Promise; /** * Gets a list of cache policies. You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listCachePolicies(input: AWS.CloudFront.ListCachePoliciesRequest, options: SdkCallOptions): Promise; /** * Lists origin access identities. */ listCloudFrontOriginAccessIdentities(input: AWS.CloudFront.ListCloudFrontOriginAccessIdentitiesRequest, options: SdkCallOptions): Promise; /** * Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own. Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist. To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listConflictingAliases(input: AWS.CloudFront.ListConflictingAliasesRequest, options: SdkCallOptions): Promise; /** * List CloudFront distributions. */ listDistributions(input: AWS.CloudFront.ListDistributionsRequest, options: SdkCallOptions): Promise; /** * Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listDistributionsByCachePolicyId(input: AWS.CloudFront.ListDistributionsByCachePolicyIdRequest, options: SdkCallOptions): Promise; /** * Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listDistributionsByKeyGroup(input: AWS.CloudFront.ListDistributionsByKeyGroupRequest, options: SdkCallOptions): Promise; /** * Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listDistributionsByOriginRequestPolicyId(input: AWS.CloudFront.ListDistributionsByOriginRequestPolicyIdRequest, options: SdkCallOptions): Promise; /** * Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration. You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listDistributionsByRealtimeLogConfig(input: AWS.CloudFront.ListDistributionsByRealtimeLogConfigRequest, options: SdkCallOptions): Promise; /** * Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified response headers policy. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listDistributionsByResponseHeadersPolicyId(input: AWS.CloudFront.ListDistributionsByResponseHeadersPolicyIdRequest, options: SdkCallOptions): Promise; /** * List the distributions that are associated with a specified WAF web ACL. */ listDistributionsByWebACLId(input: AWS.CloudFront.ListDistributionsByWebACLIdRequest, options: SdkCallOptions): Promise; /** * List all field-level encryption configurations that have been created in CloudFront for this account. */ listFieldLevelEncryptionConfigs(input: AWS.CloudFront.ListFieldLevelEncryptionConfigsRequest, options: SdkCallOptions): Promise; /** * Request a list of field-level encryption profiles that have been created in CloudFront for this account. */ listFieldLevelEncryptionProfiles(input: AWS.CloudFront.ListFieldLevelEncryptionProfilesRequest, options: SdkCallOptions): Promise; /** * Gets a list of all CloudFront functions in your Amazon Web Services account. You can optionally apply a filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listFunctions(input: AWS.CloudFront.ListFunctionsRequest, options: SdkCallOptions): Promise; /** * Lists invalidation batches. */ listInvalidations(input: AWS.CloudFront.ListInvalidationsRequest, options: SdkCallOptions): Promise; /** * Gets a list of key groups. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listKeyGroups(input: AWS.CloudFront.ListKeyGroupsRequest, options: SdkCallOptions): Promise; /** * Gets the list of CloudFront origin access controls in this Amazon Web Services account. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the NextMarker value from the current response as the Marker value in the next request. */ listOriginAccessControls(input: AWS.CloudFront.ListOriginAccessControlsRequest, options: SdkCallOptions): Promise; /** * Gets a list of origin request policies. You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listOriginRequestPolicies(input: AWS.CloudFront.ListOriginRequestPoliciesRequest, options: SdkCallOptions): Promise; /** * List all public keys that have been added to CloudFront for this account. */ listPublicKeys(input: AWS.CloudFront.ListPublicKeysRequest, options: SdkCallOptions): Promise; /** * Gets a list of real-time log configurations. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listRealtimeLogConfigs(input: AWS.CloudFront.ListRealtimeLogConfigsRequest, options: SdkCallOptions): Promise; /** * Gets a list of response headers policies. You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request. */ listResponseHeadersPolicies(input: AWS.CloudFront.ListResponseHeadersPoliciesRequest, options: SdkCallOptions): Promise; /** * List streaming distributions. */ listStreamingDistributions(input: AWS.CloudFront.ListStreamingDistributionsRequest, options: SdkCallOptions): Promise; /** * List tags for a CloudFront resource. */ listTagsForResource(input: AWS.CloudFront.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE. This automatically updates all cache behaviors that are using this function to use the newly published copy in the LIVE stage. When a function is published to the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s Amazon Resource Name (ARN). To publish a function, you must provide the function’s name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction. */ publishFunction(input: AWS.CloudFront.PublishFunctionRequest, options: SdkCallOptions): Promise; /** * Add tags to a CloudFront resource. */ tagResource(input: AWS.CloudFront.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Tests a CloudFront function. To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide. To test a function, you provide the function’s name and version (ETag value) along with the event object. To get the function’s name and version, you can use ListFunctions and DescribeFunction. */ testFunction(input: AWS.CloudFront.TestFunctionRequest, options: SdkCallOptions): Promise; /** * Remove tags from a CloudFront resource. */ untagResource(input: AWS.CloudFront.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a cache policy configuration. When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration: Use GetCachePolicyConfig to get the current configuration. Locally modify the fields in the cache policy configuration that you want to update. Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn’t. */ updateCachePolicy(input: AWS.CloudFront.UpdateCachePolicyRequest, options: SdkCallOptions): Promise; /** * Update an origin access identity. */ updateCloudFrontOriginAccessIdentity(input: AWS.CloudFront.UpdateCloudFrontOriginAccessIdentityRequest, options: SdkCallOptions): Promise; /** * Updates the configuration for a web distribution. When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide. The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates. For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide. To update a web distribution using the CloudFront API Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution. If you update the distribution again, you must get a new Etag header. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes. When you edit the XML file, be aware of the following: You must strip out the ETag parameter that is returned. Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution. You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error. The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element. Submit an UpdateDistribution request to update the configuration for your distribution: In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed. */ updateDistribution(input: AWS.CloudFront.UpdateDistributionRequest, options: SdkCallOptions): Promise; /** * Update a field-level encryption configuration. */ updateFieldLevelEncryptionConfig(input: AWS.CloudFront.UpdateFieldLevelEncryptionConfigRequest, options: SdkCallOptions): Promise; /** * Update a field-level encryption profile. */ updateFieldLevelEncryptionProfile(input: AWS.CloudFront.UpdateFieldLevelEncryptionProfileRequest, options: SdkCallOptions): Promise; /** * Updates a CloudFront function. You can update a function’s code or the comment that describes the function. You cannot update a function’s name. To update a function, you provide the function’s name and version (ETag value) along with the updated function code. To get the name and version, you can use ListFunctions and DescribeFunction. */ updateFunction(input: AWS.CloudFront.UpdateFunctionRequest, options: SdkCallOptions): Promise; /** * Updates a key group. When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group: Get the current key group with GetKeyGroup or GetKeyGroupConfig. Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs. Call UpdateKeyGroup with the entire key group object, including the fields that you modified and those that you didn’t. */ updateKeyGroup(input: AWS.CloudFront.UpdateKeyGroupRequest, options: SdkCallOptions): Promise; /** * Updates a CloudFront origin access control. */ updateOriginAccessControl(input: AWS.CloudFront.UpdateOriginAccessControlRequest, options: SdkCallOptions): Promise; /** * Updates an origin request policy configuration. When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration: Use GetOriginRequestPolicyConfig to get the current configuration. Locally modify the fields in the origin request policy configuration that you want to update. Call UpdateOriginRequestPolicy by providing the entire origin request policy configuration, including the fields that you modified and those that you didn’t. */ updateOriginRequestPolicy(input: AWS.CloudFront.UpdateOriginRequestPolicyRequest, options: SdkCallOptions): Promise; /** * Update public key information. Note that the only value you can change is the comment. */ updatePublicKey(input: AWS.CloudFront.UpdatePublicKeyRequest, options: SdkCallOptions): Promise; /** * Updates a real-time log configuration. When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration: Call GetRealtimeLogConfig to get the current real-time log configuration. Locally modify the parameters in the real-time log configuration that you want to update. Call this API (UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t. You cannot update a real-time log configuration’s Name or ARN. */ updateRealtimeLogConfig(input: AWS.CloudFront.UpdateRealtimeLogConfigRequest, options: SdkCallOptions): Promise; /** * Updates a response headers policy. When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration: Use GetResponseHeadersPolicyConfig to get the current policy’s configuration. Modify the fields in the response headers policy configuration that you want to update. Call UpdateResponseHeadersPolicy, providing the entire response headers policy configuration, including the fields that you modified and those that you didn’t. */ updateResponseHeadersPolicy(input: AWS.CloudFront.UpdateResponseHeadersPolicyRequest, options: SdkCallOptions): Promise; /** * Update a streaming distribution. */ updateStreamingDistribution(input: AWS.CloudFront.UpdateStreamingDistributionRequest, options: SdkCallOptions): Promise; } export interface CloudHSM { /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Adds or overwrites one or more tags for the specified AWS CloudHSM resource. Each tag consists of a key and a value. Tag keys must be unique to each resource. */ addTagsToResource(input: AWS.CloudHSM.AddTagsToResourceRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. */ createHapg(input: AWS.CloudHSM.CreateHapgRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an uninitialized HSM instance. There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support. It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING. */ createHsm(input: AWS.CloudHSM.CreateHsmRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an HSM client. */ createLunaClient(input: AWS.CloudHSM.CreateLunaClientRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a high-availability partition group. */ deleteHapg(input: AWS.CloudHSM.DeleteHapgRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered. */ deleteHsm(input: AWS.CloudHSM.DeleteHsmRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a client. */ deleteLunaClient(input: AWS.CloudHSM.DeleteLunaClientRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about a high-availability partition group. */ describeHapg(input: AWS.CloudHSM.DescribeHapgRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. */ describeHsm(input: AWS.CloudHSM.DescribeHsmRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM client. */ describeLunaClient(input: AWS.CloudHSM.DescribeLunaClientRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. */ getConfig(input: AWS.CloudHSM.GetConfigRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the Availability Zones that have available AWS CloudHSM capacity. */ listAvailableZones(input: AWS.CloudHSM.ListAvailableZonesRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the high-availability partition groups for the account. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items. */ listHapgs(input: AWS.CloudHSM.ListHapgsRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves the identifiers of all of the HSMs provisioned for the current customer. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items. */ listHsms(input: AWS.CloudHSM.ListHsmsRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists all of the clients. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items. */ listLunaClients(input: AWS.CloudHSM.ListLunaClientsRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Returns a list of all tags for the specified AWS CloudHSM resource. */ listTagsForResource(input: AWS.CloudHSM.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an existing high-availability partition group. */ modifyHapg(input: AWS.CloudHSM.ModifyHapgRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an HSM. This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window. */ modifyHsm(input: AWS.CloudHSM.ModifyHsmRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies the certificate used by the client. This action can potentially start a workflow to install the new certificate on the client's HSMs. */ modifyLunaClient(input: AWS.CloudHSM.ModifyLunaClientRequest, options: SdkCallOptions): Promise; /** * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Removes one or more tags from the specified AWS CloudHSM resource. To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource. */ removeTagsFromResource(input: AWS.CloudHSM.RemoveTagsFromResourceRequest, options: SdkCallOptions): Promise; } export interface CloudHSMV2 { /** * Copy an AWS CloudHSM cluster backup to a different region. */ copyBackupToRegion(input: AWS.CloudHSMV2.CopyBackupToRegionRequest, options: SdkCallOptions): Promise; /** * Creates a new AWS CloudHSM cluster. */ createCluster(input: AWS.CloudHSMV2.CreateClusterRequest, options: SdkCallOptions): Promise; /** * Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster. */ createHsm(input: AWS.CloudHSMV2.CreateHsmRequest, options: SdkCallOptions): Promise; /** * Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup. */ deleteBackup(input: AWS.CloudHSMV2.DeleteBackupRequest, options: SdkCallOptions): Promise; /** * Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm. */ deleteCluster(input: AWS.CloudHSMV2.DeleteClusterRequest, options: SdkCallOptions): Promise; /** * Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters. */ deleteHsm(input: AWS.CloudHSMV2.DeleteHsmRequest, options: SdkCallOptions): Promise; /** * Gets information about backups of AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get. */ describeBackups(input: AWS.CloudHSMV2.DescribeBackupsRequest, options: SdkCallOptions): Promise; /** * Gets information about AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get. */ describeClusters(input: AWS.CloudHSMV2.DescribeClustersRequest, options: SdkCallOptions): Promise; /** * Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters. */ initializeCluster(input: AWS.CloudHSMV2.InitializeClusterRequest, options: SdkCallOptions): Promise; /** * Gets a list of tags for the specified AWS CloudHSM cluster. This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get. */ listTags(input: AWS.CloudHSMV2.ListTagsRequest, options: SdkCallOptions): Promise; /** * Modifies attributes for AWS CloudHSM backup. */ modifyBackupAttributes(input: AWS.CloudHSMV2.ModifyBackupAttributesRequest, options: SdkCallOptions): Promise; /** * Modifies AWS CloudHSM cluster. */ modifyCluster(input: AWS.CloudHSMV2.ModifyClusterRequest, options: SdkCallOptions): Promise; /** * Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup. */ restoreBackup(input: AWS.CloudHSMV2.RestoreBackupRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites one or more tags for the specified AWS CloudHSM cluster. */ tagResource(input: AWS.CloudHSMV2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tag or tags from the specified AWS CloudHSM cluster. */ untagResource(input: AWS.CloudHSMV2.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface CloudSearch { /** * Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide. */ buildSuggesters(input: AWS.CloudSearch.BuildSuggestersRequest, options: SdkCallOptions): Promise; /** * Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide. */ createDomain(input: AWS.CloudSearch.CreateDomainRequest, options: SdkCallOptions): Promise; /** * Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. */ defineAnalysisScheme(input: AWS.CloudSearch.DefineAnalysisSchemeRequest, options: SdkCallOptions): Promise; /** * Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. */ defineExpression(input: AWS.CloudSearch.DefineExpressionRequest, options: SdkCallOptions): Promise; /** * Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide. */ defineIndexField(input: AWS.CloudSearch.DefineIndexFieldRequest, options: SdkCallOptions): Promise; /** * Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. */ defineSuggester(input: AWS.CloudSearch.DefineSuggesterRequest, options: SdkCallOptions): Promise; /** * Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. */ deleteAnalysisScheme(input: AWS.CloudSearch.DeleteAnalysisSchemeRequest, options: SdkCallOptions): Promise; /** * Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide. */ deleteDomain(input: AWS.CloudSearch.DeleteDomainRequest, options: SdkCallOptions): Promise; /** * Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. */ deleteExpression(input: AWS.CloudSearch.DeleteExpressionRequest, options: SdkCallOptions): Promise; /** * Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide. */ deleteIndexField(input: AWS.CloudSearch.DeleteIndexFieldRequest, options: SdkCallOptions): Promise; /** * Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. */ deleteSuggester(input: AWS.CloudSearch.DeleteSuggesterRequest, options: SdkCallOptions): Promise; /** * Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. */ describeAnalysisSchemes(input: AWS.CloudSearch.DescribeAnalysisSchemesRequest, options: SdkCallOptions): Promise; /** * Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide. */ describeAvailabilityOptions(input: AWS.CloudSearch.DescribeAvailabilityOptionsRequest, options: SdkCallOptions): Promise; /** * Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide. */ describeDomainEndpointOptions(input: AWS.CloudSearch.DescribeDomainEndpointOptionsRequest, options: SdkCallOptions): Promise; /** * Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide. */ describeDomains(input: AWS.CloudSearch.DescribeDomainsRequest, options: SdkCallOptions): Promise; /** * Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide. */ describeExpressions(input: AWS.CloudSearch.DescribeExpressionsRequest, options: SdkCallOptions): Promise; /** * Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide. */ describeIndexFields(input: AWS.CloudSearch.DescribeIndexFieldsRequest, options: SdkCallOptions): Promise; /** * Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. */ describeScalingParameters(input: AWS.CloudSearch.DescribeScalingParametersRequest, options: SdkCallOptions): Promise; /** * Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. */ describeServiceAccessPolicies(input: AWS.CloudSearch.DescribeServiceAccessPoliciesRequest, options: SdkCallOptions): Promise; /** * Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. */ describeSuggesters(input: AWS.CloudSearch.DescribeSuggestersRequest, options: SdkCallOptions): Promise; /** * Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments. */ indexDocuments(input: AWS.CloudSearch.IndexDocumentsRequest, options: SdkCallOptions): Promise; /** * Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide. */ updateAvailabilityOptions(input: AWS.CloudSearch.UpdateAvailabilityOptionsRequest, options: SdkCallOptions): Promise; /** * Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide. */ updateDomainEndpointOptions(input: AWS.CloudSearch.UpdateDomainEndpointOptionsRequest, options: SdkCallOptions): Promise; /** * Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. */ updateScalingParameters(input: AWS.CloudSearch.UpdateScalingParametersRequest, options: SdkCallOptions): Promise; /** * Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain. */ updateServiceAccessPolicies(input: AWS.CloudSearch.UpdateServiceAccessPoliciesRequest, options: SdkCallOptions): Promise; } export interface CloudSearchDomain { /** * Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: simple: search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes. structured: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching. lucene: specify search criteria using the Apache Lucene query parser syntax. dismax: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide. The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. */ search(input: AWS.CloudSearchDomain.SearchRequest, options: SdkCallOptions): Promise; /** * Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide. The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. */ suggest(input: AWS.CloudSearchDomain.SuggestRequest, options: SdkCallOptions): Promise; /** * Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide. */ uploadDocuments(input: AWS.CloudSearchDomain.UploadDocumentsRequest, options: SdkCallOptions): Promise; } export interface CloudTrail { /** * Adds one or more tags to a trail or event data store, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home region). */ addTags(input: AWS.CloudTrail.AddTagsRequest, options: SdkCallOptions): Promise; /** * Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished. */ cancelQuery(input: AWS.CloudTrail.CancelQueryRequest, options: SdkCallOptions): Promise; /** * Creates a new event data store. */ createEventDataStore(input: AWS.CloudTrail.CreateEventDataStoreRequest, options: SdkCallOptions): Promise; /** * Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. */ createTrail(input: AWS.CloudTrail.CreateTrailRequest, options: SdkCallOptions): Promise; /** * Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store; this operation cannot work if TerminationProtectionEnabled is True. After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, DescribeQuery, or GetQueryResults on queries that are using an event data store in a PENDING_DELETION state. An event data store in the PENDING_DELETION state does not incur costs. */ deleteEventDataStore(input: AWS.CloudTrail.DeleteEventDataStoreRequest, options: SdkCallOptions): Promise; /** * Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. */ deleteTrail(input: AWS.CloudTrail.DeleteTrailRequest, options: SdkCallOptions): Promise; /** * Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for EventDataStore, and a value for QueryID. */ describeQuery(input: AWS.CloudTrail.DescribeQueryRequest, options: SdkCallOptions): Promise; /** * Retrieves settings for one or more trails associated with the current region for your account. */ describeTrails(input: AWS.CloudTrail.DescribeTrailsRequest, options: SdkCallOptions): Promise; /** * Returns the specified CloudTrail service-linked channel. Amazon Web Services services create service-linked channels to view CloudTrail events. */ getChannel(input: AWS.CloudTrail.GetChannelRequest, options: SdkCallOptions): Promise; /** * Returns information about an event data store specified as either an ARN or the ID portion of the ARN. */ getEventDataStore(input: AWS.CloudTrail.GetEventDataStoreRequest, options: SdkCallOptions): Promise; /** * Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following: If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events. If your event selector includes management events. If your event selector includes data events, the resources on which you are logging data events. For more information about logging management and data events, see the following topics in the CloudTrail User Guide: Logging management events for trails Logging data events for trails */ getEventSelectors(input: AWS.CloudTrail.GetEventSelectorsRequest, options: SdkCallOptions): Promise; /** * Returns information for the specified import. */ getImport(input: AWS.CloudTrail.GetImportRequest, options: SdkCallOptions): Promise; /** * Describes the settings for the Insights event selectors that you configured for your trail. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide. */ getInsightSelectors(input: AWS.CloudTrail.GetInsightSelectorsRequest, options: SdkCallOptions): Promise; /** * Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation, and an ARN for EventDataStore. */ getQueryResults(input: AWS.CloudTrail.GetQueryResultsRequest, options: SdkCallOptions): Promise; /** * Returns settings information for a specified trail. */ getTrail(input: AWS.CloudTrail.GetTrailRequest, options: SdkCallOptions): Promise; /** * Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. */ getTrailStatus(input: AWS.CloudTrail.GetTrailStatusRequest, options: SdkCallOptions): Promise; /** * Returns all CloudTrail channels. */ listChannels(input: AWS.CloudTrail.ListChannelsRequest, options: SdkCallOptions): Promise; /** * Returns information about all event data stores in the account, in the current region. */ listEventDataStores(input: AWS.CloudTrail.ListEventDataStoresRequest, options: SdkCallOptions): Promise; /** * Returns a list of failures for the specified import. */ listImportFailures(input: AWS.CloudTrail.ListImportFailuresRequest, options: SdkCallOptions): Promise; /** * Returns information on all imports, or a select set of imports by ImportStatus or Destination. */ listImports(input: AWS.CloudTrail.ListImportsRequest, options: SdkCallOptions): Promise; /** * Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. CloudTrail uses different private and public key pairs per region. Each digest file is signed with a private key unique to its region. When you validate a digest file from a specific region, you must look in the same region for its corresponding public key. */ listPublicKeys(input: AWS.CloudTrail.ListPublicKeysRequest, options: SdkCallOptions): Promise; /** * Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED. */ listQueries(input: AWS.CloudTrail.ListQueriesRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the trail or event data store in the current region. */ listTags(input: AWS.CloudTrail.ListTagsRequest, options: SdkCallOptions): Promise; /** * Lists trails that are in the current account. */ listTrails(input: AWS.CloudTrail.ListTrailsRequest, options: SdkCallOptions): Promise; /** * Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events: Amazon Web Services access key Event ID Event name Event source Read only Resource name Resource type User name Lookup supports the following attributes for Insights events: Event ID Event name Event source All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs. */ lookupEvents(input: AWS.CloudTrail.LookupEventsRequest, options: SdkCallOptions): Promise; /** * Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. Example You create an event selector for a trail and specify that you want write-only events. The EC2 GetConsoleOutput and RunInstances API operations occur in your account. CloudTrail evaluates whether the events match your event selectors. The RunInstances is a write-only event and it matches your event selector. The trail logs the event. The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't log the event. The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown. You can configure up to five event selectors for each trail. For more information, see Logging management events for trails , Logging data events for trails , and Quotas in CloudTrail in the CloudTrail User Guide. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide. */ putEventSelectors(input: AWS.CloudTrail.PutEventSelectorsRequest, options: SdkCallOptions): Promise; /** * Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight and ApiCallRateInsight. */ putInsightSelectors(input: AWS.CloudTrail.PutInsightSelectorsRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from a trail or event data store. */ removeTags(input: AWS.CloudTrail.RemoveTagsRequest, options: SdkCallOptions): Promise; /** * Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store. */ restoreEventDataStore(input: AWS.CloudTrail.RestoreEventDataStoreRequest, options: SdkCallOptions): Promise; /** * Starts an import of logged trail events from a source S3 bucket to a destination event data store. When you start a new import, the Destinations and ImportSource parameters are required. Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more information about disabling ACLs, see Controlling ownership of objects and disabling ACLs for your bucket. When you retry an import, the ImportID parameter is required. */ startImport(input: AWS.CloudTrail.StartImportRequest, options: SdkCallOptions): Promise; /** * Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. */ startLogging(input: AWS.CloudTrail.StartLoggingRequest, options: SdkCallOptions): Promise; /** * Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query, enclosed in single quotation marks. */ startQuery(input: AWS.CloudTrail.StartQueryRequest, options: SdkCallOptions): Promise; /** * Stops a specified import. */ stopImport(input: AWS.CloudTrail.StopImportRequest, options: SdkCallOptions): Promise; /** * Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. */ stopLogging(input: AWS.CloudTrail.StopLoggingRequest, options: SdkCallOptions): Promise; /** * Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 90 and 2557. By default, TerminationProtection is enabled. AdvancedEventSelectors includes or excludes management and data events in your event data store; for more information about AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors. */ updateEventDataStore(input: AWS.CloudTrail.UpdateEventDataStoreRequest, options: SdkCallOptions): Promise; /** * Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown. */ updateTrail(input: AWS.CloudTrail.UpdateTrailRequest, options: SdkCallOptions): Promise; } export interface CloudWatch { /** * Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation. In the event of an error, no alarms are deleted. It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete. To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False. Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. */ deleteAlarms(input: AWS.CloudWatch.DeleteAlarmsInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide. */ deleteAnomalyDetector(input: AWS.CloudWatch.DeleteAnomalyDetectorInput, options: SdkCallOptions): Promise; /** * Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted. */ deleteDashboards(input: AWS.CloudWatch.DeleteDashboardsInput, options: SdkCallOptions): Promise; /** * Permanently deletes the specified Contributor Insights rules. If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available. */ deleteInsightRules(input: AWS.CloudWatch.DeleteInsightRulesInput, options: SdkCallOptions): Promise; /** * Permanently deletes the metric stream that you specify. */ deleteMetricStream(input: AWS.CloudWatch.DeleteMetricStreamInput, options: SdkCallOptions): Promise; /** * Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned. CloudWatch retains the history of an alarm even if you delete the alarm. To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope. */ describeAlarmHistory(input: AWS.CloudWatch.DescribeAlarmHistoryInput, options: SdkCallOptions): Promise; /** * Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action. To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope. */ describeAlarms(input: AWS.CloudWatch.DescribeAlarmsInput, options: SdkCallOptions): Promise; /** * Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit. This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric. */ describeAlarmsForMetric(input: AWS.CloudWatch.DescribeAlarmsForMetricInput, options: SdkCallOptions): Promise; /** * Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account. */ describeAnomalyDetectors(input: AWS.CloudWatch.DescribeAnomalyDetectorsInput, options: SdkCallOptions): Promise; /** * Returns a list of all the Contributor Insights rules in your account. For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data. */ describeInsightRules(input: AWS.CloudWatch.DescribeInsightRulesInput, options: SdkCallOptions): Promise; /** * Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes. */ disableAlarmActions(input: AWS.CloudWatch.DisableAlarmActionsInput, options: SdkCallOptions): Promise<{}>; /** * Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs. */ disableInsightRules(input: AWS.CloudWatch.DisableInsightRulesInput, options: SdkCallOptions): Promise; /** * Enables the actions for the specified alarms. */ enableAlarmActions(input: AWS.CloudWatch.EnableAlarmActionsInput, options: SdkCallOptions): Promise<{}>; /** * Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data. */ enableInsightRules(input: AWS.CloudWatch.EnableInsightRulesInput, options: SdkCallOptions): Promise; /** * Displays the details of the dashboard that you specify. To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy. */ getDashboard(input: AWS.CloudWatch.GetDashboardInput, options: SdkCallOptions): Promise; /** * This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group. You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following: UniqueContributors -- the number of unique contributors for each data point. MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph. If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period. SampleCount -- the number of data points matched by the rule. Sum -- the sum of the values from all contributors during the time period represented by that data point. Minimum -- the minimum value from a single observation during the time period represented by that data point. Maximum -- the maximum value from a single observation during the time period represented by that data point. Average -- the average value from all contributors during the time period represented by that data point. */ getInsightRuleReport(input: AWS.CloudWatch.GetInsightRuleReportInput, options: SdkCallOptions): Promise; /** * You can use the GetMetricData API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and one or more metric math functions. A GetMetricData operation that does not include a query can retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform metric math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide. If you include a Metrics Insights query, each GetMetricData operation can include only one query. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries can query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights. Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing. Amazon CloudWatch retains metric data as follows: Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1. Data points with a period of 60 seconds (1-minute) are available for 15 days. Data points with a period of 300 seconds (5-minute) are available for 63 days. Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months). Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour. If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions. Using Metrics Insights queries with metric math You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series. */ getMetricData(input: AWS.CloudWatch.GetMetricDataInput, options: SdkCallOptions): Promise; /** * Gets statistics for the specified metric. The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order. CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned. CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true: The SampleCount value of the statistic set is 1. The Min and the Max values of the statistic set are equal. Percentile statistics are not available for metrics when any of the metric values are negative numbers. Amazon CloudWatch retains metric data as follows: Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1. Data points with a period of 60 seconds (1-minute) are available for 15 days. Data points with a period of 300 seconds (5-minute) are available for 63 days. Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months). Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour. CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016. For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide. */ getMetricStatistics(input: AWS.CloudWatch.GetMetricStatisticsInput, options: SdkCallOptions): Promise; /** * Returns information about the metric stream that you specify. */ getMetricStream(input: AWS.CloudWatch.GetMetricStreamInput, options: SdkCallOptions): Promise; /** * You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard. The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations. There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits: As many as 100 metrics in the graph. Up to 100 KB uncompressed payload. */ getMetricWidgetImage(input: AWS.CloudWatch.GetMetricWidgetImageInput, options: SdkCallOptions): Promise; /** * Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results. */ listDashboards(input: AWS.CloudWatch.ListDashboardsInput, options: SdkCallOptions): Promise; /** * Returns a list that contains the number of managed Contributor Insights rules in your account. */ listManagedInsightRules(input: AWS.CloudWatch.ListManagedInsightRulesInput, options: SdkCallOptions): Promise; /** * Returns a list of metric streams in this account. */ listMetricStreams(input: AWS.CloudWatch.ListMetricStreamsInput, options: SdkCallOptions): Promise; /** * List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data. Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls. After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics. ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics. */ listMetrics(input: AWS.CloudWatch.ListMetricsInput, options: SdkCallOptions): Promise; /** * Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging. */ listTagsForResource(input: AWS.CloudWatch.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed. For more information, see CloudWatch Anomaly Detection. */ putAnomalyDetector(input: AWS.CloudWatch.PutAnomalyDetectorInput, options: SdkCallOptions): Promise; /** * Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met. The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be included in the rule expressions of as many as 150 composite alarms. Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state. Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics. It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete. To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False. Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope. If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions. */ putCompositeAlarm(input: AWS.CloudWatch.PutCompositeAlarmInput, options: SdkCallOptions): Promise<{}>; /** * Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here. All dashboards in your account are global, not region-specific. A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard. When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard. */ putDashboard(input: AWS.CloudWatch.PutDashboardInput, options: SdkCallOptions): Promise; /** * Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data. If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available. */ putInsightRule(input: AWS.CloudWatch.PutInsightRuleInput, options: SdkCallOptions): Promise; /** * Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You cannot edit these rules with PutInsightRule. The rules can be enabled, disabled, and deleted using EnableInsightRules, DisableInsightRules, and DeleteInsightRules. If a previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use ListManagedInsightRules to describe all available rules. */ putManagedInsightRules(input: AWS.CloudWatch.PutManagedInsightRulesInput, options: SdkCallOptions): Promise; /** * Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model. Alarms based on anomaly detection models cannot have Auto Scaling actions. When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations: The iam:CreateServiceLinkedRole for all alarms with EC2 actions The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions. The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role. Cross-account alarms You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites: The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm. The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console. */ putMetricAlarm(input: AWS.CloudWatch.PutMetricAlarmInput, options: SdkCallOptions): Promise<{}>; /** * Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics. You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data. Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 1000 different metrics. Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported. You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide. You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time. Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics. CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true: The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal. The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount. */ putMetricData(input: AWS.CloudWatch.PutMetricDataInput, options: SdkCallOptions): Promise<{}>; /** * Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations including Amazon S3 and to many third-party solutions. For more information, see Using Metric Streams. To create a metric stream, you must be logged on to an account that has the iam:PassRole permission and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream permission. When you create or update a metric stream, you choose one of the following: Stream metrics from all metric namespaces in the account. Stream metrics from all metric namespaces in the account, except for the namespaces that you list in ExcludeFilters. Stream metrics from only the metric namespaces that you list in IncludeFilters. By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use the StatisticsConfigurations parameter to have the metric stream also send additional statistics in the stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing. When you use PutMetricStream to create a new metric stream, the stream is created in the running state. If you use it to update an existing stream, the state of the stream is not changed. */ putMetricStream(input: AWS.CloudWatch.PutMetricStreamInput, options: SdkCallOptions): Promise; /** * Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory. If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration. If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action. */ setAlarmState(input: AWS.CloudWatch.SetAlarmStateInput, options: SdkCallOptions): Promise<{}>; /** * Starts the streaming of metrics for one or more of your metric streams. */ startMetricStreams(input: AWS.CloudWatch.StartMetricStreamsInput, options: SdkCallOptions): Promise; /** * Stops the streaming of metrics for one or more of your metric streams. */ stopMetricStreams(input: AWS.CloudWatch.StopMetricStreamsInput, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a CloudWatch resource. */ tagResource(input: AWS.CloudWatch.TagResourceInput, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. */ untagResource(input: AWS.CloudWatch.UntagResourceInput, options: SdkCallOptions): Promise; } export interface CloudWatchEvents { /** * Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source. */ activateEventSource(input: AWS.CloudWatchEvents.ActivateEventSourceRequest, options: SdkCallOptions): Promise<{}>; /** * Cancels the specified replay. */ cancelReplay(input: AWS.CloudWatchEvents.CancelReplayRequest, options: SdkCallOptions): Promise; /** * Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. */ createApiDestination(input: AWS.CloudWatchEvents.CreateApiDestinationRequest, options: SdkCallOptions): Promise; /** * Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive. */ createArchive(input: AWS.CloudWatchEvents.CreateArchiveRequest, options: SdkCallOptions): Promise; /** * Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. */ createConnection(input: AWS.CloudWatchEvents.CreateConnectionRequest, options: SdkCallOptions): Promise; /** * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source. */ createEventBus(input: AWS.CloudWatchEvents.CreateEventBusRequest, options: SdkCallOptions): Promise; /** * Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types. A partner event source creates events based on resources within the SaaS partner's service or application. An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets. Partner event source names follow this format: partner_name/event_namespace/event_name partner_name is determined during partner registration and identifies the partner to Amazon Web Services customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events. */ createPartnerEventSource(input: AWS.CloudWatchEvents.CreatePartnerEventSourceRequest, options: SdkCallOptions): Promise; /** * You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted. To activate a deactivated partner event source, use ActivateEventSource. */ deactivateEventSource(input: AWS.CloudWatchEvents.DeactivateEventSourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection. */ deauthorizeConnection(input: AWS.CloudWatchEvents.DeauthorizeConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified API destination. */ deleteApiDestination(input: AWS.CloudWatchEvents.DeleteApiDestinationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified archive. */ deleteArchive(input: AWS.CloudWatchEvents.DeleteArchiveRequest, options: SdkCallOptions): Promise; /** * Deletes a connection. */ deleteConnection(input: AWS.CloudWatchEvents.DeleteConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus. */ deleteEventBus(input: AWS.CloudWatchEvents.DeleteEventBusRequest, options: SdkCallOptions): Promise<{}>; /** * This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED. */ deletePartnerEventSource(input: AWS.CloudWatchEvents.DeletePartnerEventSourceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule. */ deleteRule(input: AWS.CloudWatchEvents.DeleteRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves details about an API destination. */ describeApiDestination(input: AWS.CloudWatchEvents.DescribeApiDestinationRequest, options: SdkCallOptions): Promise; /** * Retrieves details about an archive. */ describeArchive(input: AWS.CloudWatchEvents.DescribeArchiveRequest, options: SdkCallOptions): Promise; /** * Retrieves details about a connection. */ describeConnection(input: AWS.CloudWatchEvents.DescribeConnectionRequest, options: SdkCallOptions): Promise; /** * Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time. To enable your account to receive events from other accounts on its default event bus, use PutPermission. For more information about partner event buses, see CreateEventBus. */ describeEventBus(input: AWS.CloudWatchEvents.DescribeEventBusRequest, options: SdkCallOptions): Promise; /** * This operation lists details about a partner event source that is shared with your account. */ describeEventSource(input: AWS.CloudWatchEvents.DescribeEventSourceRequest, options: SdkCallOptions): Promise; /** * An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them. */ describePartnerEventSource(input: AWS.CloudWatchEvents.DescribePartnerEventSourceRequest, options: SdkCallOptions): Promise; /** * Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed. */ describeReplay(input: AWS.CloudWatchEvents.DescribeReplayRequest, options: SdkCallOptions): Promise; /** * Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. */ describeRule(input: AWS.CloudWatchEvents.DescribeRuleRequest, options: SdkCallOptions): Promise; /** * Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect. */ disableRule(input: AWS.CloudWatchEvents.DisableRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Enables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect. */ enableRule(input: AWS.CloudWatchEvents.EnableRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves a list of API destination in the account in the current Region. */ listApiDestinations(input: AWS.CloudWatchEvents.ListApiDestinationsRequest, options: SdkCallOptions): Promise; /** * Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive. */ listArchives(input: AWS.CloudWatchEvents.ListArchivesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of connections from the account. */ listConnections(input: AWS.CloudWatchEvents.ListConnectionsRequest, options: SdkCallOptions): Promise; /** * Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses. */ listEventBuses(input: AWS.CloudWatchEvents.ListEventBusesRequest, options: SdkCallOptions): Promise; /** * You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus. */ listEventSources(input: AWS.CloudWatchEvents.ListEventSourcesRequest, options: SdkCallOptions): Promise; /** * An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers. */ listPartnerEventSourceAccounts(input: AWS.CloudWatchEvents.ListPartnerEventSourceAccountsRequest, options: SdkCallOptions): Promise; /** * An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers. */ listPartnerEventSources(input: AWS.CloudWatchEvents.ListPartnerEventSourcesRequest, options: SdkCallOptions): Promise; /** * Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive. */ listReplays(input: AWS.CloudWatchEvents.ListReplaysRequest, options: SdkCallOptions): Promise; /** * Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account. */ listRuleNamesByTarget(input: AWS.CloudWatchEvents.ListRuleNamesByTargetRequest, options: SdkCallOptions): Promise; /** * Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. */ listRules(input: AWS.CloudWatchEvents.ListRulesRequest, options: SdkCallOptions): Promise; /** * Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged. */ listTagsForResource(input: AWS.CloudWatchEvents.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the targets assigned to the specified rule. */ listTargetsByRule(input: AWS.CloudWatchEvents.ListTargetsByRuleRequest, options: SdkCallOptions): Promise; /** * Sends custom events to Amazon EventBridge so that they can be matched to rules. */ putEvents(input: AWS.CloudWatchEvents.PutEventsRequest, options: SdkCallOptions): Promise; /** * This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation. */ putPartnerEvents(input: AWS.CloudWatchEvents.PutPartnerEventsRequest, options: SdkCallOptions): Promise; /** * Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account. For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target. To enable multiple Amazon Web Services accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide. The permission policy on the event bus cannot exceed 10 KB in size. */ putPermission(input: AWS.CloudWatchEvents.PutPermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule. A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus. If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets. */ putRule(input: AWS.CloudWatchEvents.PutRuleRequest, options: SdkCallOptions): Promise; /** * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets for Events: API destination Amazon API Gateway REST API endpoints API Gateway Batch job queue CloudWatch Logs group CodeBuild project CodePipeline Amazon EC2 CreateSnapshot API call Amazon EC2 RebootInstances API call Amazon EC2 StopInstances API call Amazon EC2 TerminateInstances API call Amazon ECS tasks Event bus in a different Amazon Web Services account or Region. You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule. Firehose delivery stream (Kinesis Data Firehose) Inspector assessment template (Amazon Inspector) Kinesis stream (Kinesis Data Stream) Lambda function Redshift clusters (Data API statement execution) Amazon SNS topic Amazon SQS queues (includes FIFO queues SSM Automation SSM OpsItem SSM Run Command Step Functions state machines Creating rules with built-in targets is supported only in the Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide. If another Amazon Web Services account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services account. If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. */ putTargets(input: AWS.CloudWatchEvents.PutTargetsRequest, options: SdkCallOptions): Promise; /** * Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus. */ removePermission(input: AWS.CloudWatchEvents.RemovePermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. */ removeTargets(input: AWS.CloudWatchEvents.RemoveTargetsRequest, options: SdkCallOptions): Promise; /** * Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed. */ startReplay(input: AWS.CloudWatchEvents.StartReplayRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. */ tagResource(input: AWS.CloudWatchEvents.TagResourceRequest, options: SdkCallOptions): Promise; /** * Tests whether the specified event pattern matches the provided event. Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. */ testEventPattern(input: AWS.CloudWatchEvents.TestEventPatternRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged. */ untagResource(input: AWS.CloudWatchEvents.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an API destination. */ updateApiDestination(input: AWS.CloudWatchEvents.UpdateApiDestinationRequest, options: SdkCallOptions): Promise; /** * Updates the specified archive. */ updateArchive(input: AWS.CloudWatchEvents.UpdateArchiveRequest, options: SdkCallOptions): Promise; /** * Updates settings for a connection. */ updateConnection(input: AWS.CloudWatchEvents.UpdateConnectionRequest, options: SdkCallOptions): Promise; } export interface CloudWatchLogs { /** * Associates the specified Key Management Service customer master key (CMK) with the specified log group. Associating an KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys. It can take up to 5 minutes for this operation to take effect. If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error. */ associateKmsKey(input: AWS.CloudWatchLogs.AssociateKmsKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Cancels the specified export task. The task must be in the PENDING or RUNNING state. */ cancelExportTask(input: AWS.CloudWatchLogs.CancelExportTaskRequest, options: SdkCallOptions): Promise<{}>; /** * Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination. Exporting log data to Amazon S3 buckets that are encrypted by KMS is not supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is not supported. Exporting to S3 buckets that are encrypted with AES-256 is supported. This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask. You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects. Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log fild data by using Linux utilities. */ createExportTask(input: AWS.CloudWatchLogs.CreateExportTaskRequest, options: SdkCallOptions): Promise; /** * Creates a log group with the specified name. You can create up to 20,000 log groups per account. You must use the following guidelines when naming a log group: Log group names must be unique within a region for an Amazon Web Services account. Log group names can be between 1 and 512 characters long. Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign) When you create a log group, by default the log events in the log group never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy. If you associate a Key Management Service customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error. CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys. */ createLogGroup(input: AWS.CloudWatchLogs.CreateLogGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored. There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled. You must use the following guidelines when naming a log stream: Log stream names must be unique within the log group. Log stream names can be between 1 and 512 characters long. The ':' (colon) and '*' (asterisk) characters are not allowed. */ createLogStream(input: AWS.CloudWatchLogs.CreateLogStreamRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination. */ deleteDestination(input: AWS.CloudWatchLogs.DeleteDestinationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified log group and permanently deletes all the archived log events associated with the log group. */ deleteLogGroup(input: AWS.CloudWatchLogs.DeleteLogGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. */ deleteLogStream(input: AWS.CloudWatchLogs.DeleteLogStreamRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified metric filter. */ deleteMetricFilter(input: AWS.CloudWatchLogs.DeleteMetricFilterRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query. Each DeleteQueryDefinition operation can delete one query definition. You must have the logs:DeleteQueryDefinition permission to be able to perform this operation. */ deleteQueryDefinition(input: AWS.CloudWatchLogs.DeleteQueryDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. */ deleteResourcePolicy(input: AWS.CloudWatchLogs.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified retention policy. Log events do not expire if they belong to log groups without a retention policy. */ deleteRetentionPolicy(input: AWS.CloudWatchLogs.DeleteRetentionPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified subscription filter. */ deleteSubscriptionFilter(input: AWS.CloudWatchLogs.DeleteSubscriptionFilterRequest, options: SdkCallOptions): Promise<{}>; /** * Lists all your destinations. The results are ASCII-sorted by destination name. */ describeDestinations(input: AWS.CloudWatchLogs.DescribeDestinationsRequest, options: SdkCallOptions): Promise; /** * Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. */ describeExportTasks(input: AWS.CloudWatchLogs.DescribeExportTasksRequest, options: SdkCallOptions): Promise; /** * Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name. CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. */ describeLogGroups(input: AWS.CloudWatchLogs.DescribeLogGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered. This operation has a limit of five transactions per second, after which transactions are throttled. */ describeLogStreams(input: AWS.CloudWatchLogs.DescribeLogStreamsRequest, options: SdkCallOptions): Promise; /** * Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name. */ describeMetricFilters(input: AWS.CloudWatchLogs.DescribeMetricFiltersRequest, options: SdkCallOptions): Promise; /** * Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status. */ describeQueries(input: AWS.CloudWatchLogs.DescribeQueriesRequest, options: SdkCallOptions): Promise; /** * This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string. */ describeQueryDefinitions(input: AWS.CloudWatchLogs.DescribeQueryDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists the resource policies in this account. */ describeResourcePolicies(input: AWS.CloudWatchLogs.DescribeResourcePoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name. */ describeSubscriptionFilters(input: AWS.CloudWatchLogs.DescribeSubscriptionFiltersRequest, options: SdkCallOptions): Promise; /** * Disassociates the associated Key Management Service customer master key (CMK) from the specified log group. After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect. */ disassociateKmsKey(input: AWS.CloudWatchLogs.DisassociateKmsKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream. By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token. The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request. */ filterLogEvents(input: AWS.CloudWatchLogs.FilterLogEventsRequest, options: SdkCallOptions): Promise; /** * Lists log events from the specified log stream. You can list all of the log events or filter using a time range. By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token. */ getLogEvents(input: AWS.CloudWatchLogs.GetLogEventsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify. In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields. The response results are sorted by the frequency percentage, starting with the highest percentage. */ getLogGroupFields(input: AWS.CloudWatchLogs.GetLogGroupFieldsRequest, options: SdkCallOptions): Promise; /** * Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs. The full unparsed log event is returned within @message. */ getLogRecord(input: AWS.CloudWatchLogs.GetLogRecordRequest, options: SdkCallOptions): Promise; /** * Returns the results from the specified query. Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record. GetQueryResults does not start a query execution. To run a query, use StartQuery. If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results. */ getQueryResults(input: AWS.CloudWatchLogs.GetQueryResultsRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified log group. */ listTagsLogGroup(input: AWS.CloudWatchLogs.ListTagsLogGroupRequest, options: SdkCallOptions): Promise; /** * Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination. To perform a PutDestination operation, you must also have the iam:PassRole permission. */ putDestination(input: AWS.CloudWatchLogs.PutDestinationRequest, options: SdkCallOptions): Promise; /** * Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination. If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed separately in the policy. The policy does not support specifying * as the Principal or the use of the aws:PrincipalOrgId global key. */ putDestinationPolicy(input: AWS.CloudWatchLogs.PutDestinationPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Uploads a batch of log events to the specified log stream. You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected. The batch of events must satisfy the following constraints: The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. None of the log events in the batch can be more than 2 hours in the future. None of the log events in the batch can be older than 14 days or older than the retention period of the log group. The log events in the batch must be in chronological order by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.) A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails. The maximum number of log events in a batch is 10,000. There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed. If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid Amazon Web Services access key ID or secret key. */ putLogEvents(input: AWS.CloudWatchLogs.PutLogEventsRequest, options: SdkCallOptions): Promise; /** * Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents. The maximum number of metric filters that can be associated with a log group is 100. When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges. */ putMetricFilter(input: AWS.CloudWatchLogs.PutMetricFilterRequest, options: SdkCallOptions): Promise<{}>; /** * Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights. To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, if you update a current query definition that includes log groups, and you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups. You must have the logs:PutQueryDefinition permission to be able to perform this operation. */ putQueryDefinition(input: AWS.CloudWatchLogs.PutQueryDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region. */ putResourcePolicy(input: AWS.CloudWatchLogs.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group. */ putRetentionPolicy(input: AWS.CloudWatchLogs.PutRetentionPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the gzip format. The following destinations are supported for subscription filters: An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. A logical destination that belongs to a different account, for cross-account delivery. An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. An Lambda function that belongs to the same account as the subscription filter, for same-account delivery. Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName. To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole permission. */ putSubscriptionFilter(input: AWS.CloudWatchLogs.PutSubscriptionFilterRequest, options: SdkCallOptions): Promise<{}>; /** * Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax. Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries. */ startQuery(input: AWS.CloudWatchLogs.StartQueryRequest, options: SdkCallOptions): Promise; /** * Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running. */ stopQuery(input: AWS.CloudWatchLogs.StopQueryRequest, options: SdkCallOptions): Promise; /** * Adds or updates the specified tags for the specified log group. To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup. For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide. CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. */ tagLogGroup(input: AWS.CloudWatchLogs.TagLogGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. */ testMetricFilter(input: AWS.CloudWatchLogs.TestMetricFilterRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified log group. To list the tags for a log group, use ListTagsLogGroup. To add tags, use TagLogGroup. CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. */ untagLogGroup(input: AWS.CloudWatchLogs.UntagLogGroupRequest, options: SdkCallOptions): Promise<{}>; } export interface CodeArtifact { /** * Adds an existing external connection to a repository. One external connection is allowed per repository. A repository can have one or more upstream repositories, or an external connection. */ associateExternalConnection(input: AWS.CodeArtifact.AssociateExternalConnectionRequest, options: SdkCallOptions): Promise; /** * Copies package versions from one repository to another repository in the same domain. You must specify versions or versionRevisions. You cannot specify both. */ copyPackageVersions(input: AWS.CodeArtifact.CopyPackageVersionsRequest, options: SdkCallOptions): Promise; /** * Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it's in multiple repositories. Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration. */ createDomain(input: AWS.CodeArtifact.CreateDomainRequest, options: SdkCallOptions): Promise; /** * Creates a repository. */ createRepository(input: AWS.CodeArtifact.CreateRepositoryRequest, options: SdkCallOptions): Promise; /** * Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories. */ deleteDomain(input: AWS.CodeArtifact.DeleteDomainRequest, options: SdkCallOptions): Promise; /** * Deletes the resource policy set on a domain. */ deleteDomainPermissionsPolicy(input: AWS.CodeArtifact.DeleteDomainPermissionsPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListackageVersions), but you can restore them using UpdatePackageVersionsStatus. */ deletePackageVersions(input: AWS.CodeArtifact.DeletePackageVersionsRequest, options: SdkCallOptions): Promise; /** * Deletes a repository. */ deleteRepository(input: AWS.CodeArtifact.DeleteRepositoryRequest, options: SdkCallOptions): Promise; /** * Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate. Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy. */ deleteRepositoryPermissionsPolicy(input: AWS.CodeArtifact.DeleteRepositoryPermissionsPolicyRequest, options: SdkCallOptions): Promise; /** * Returns a DomainDescription object that contains information about the requested domain. */ describeDomain(input: AWS.CodeArtifact.DescribeDomainRequest, options: SdkCallOptions): Promise; /** * Returns a PackageDescription object that contains information about the requested package. */ describePackage(input: AWS.CodeArtifact.DescribePackageRequest, options: SdkCallOptions): Promise; /** * Returns a PackageVersionDescription object that contains information about the requested package version. */ describePackageVersion(input: AWS.CodeArtifact.DescribePackageVersionRequest, options: SdkCallOptions): Promise; /** * Returns a RepositoryDescription object that contains detailed information about the requested repository. */ describeRepository(input: AWS.CodeArtifact.DescribeRepositoryRequest, options: SdkCallOptions): Promise; /** * Removes an existing external connection from a repository. */ disassociateExternalConnection(input: AWS.CodeArtifact.DisassociateExternalConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted. To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed. To view information about a disposed package version, use DescribePackageVersion. */ disposePackageVersions(input: AWS.CodeArtifact.DisposePackageVersionsRequest, options: SdkCallOptions): Promise; /** * Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens. CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter. The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration. See Using IAM Roles for more information on controlling session duration. */ getAuthorizationToken(input: AWS.CodeArtifact.GetAuthorizationTokenRequest, options: SdkCallOptions): Promise; /** * Returns the resource policy attached to the specified domain. The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide. */ getDomainPermissionsPolicy(input: AWS.CodeArtifact.GetDomainPermissionsPolicyRequest, options: SdkCallOptions): Promise; /** * Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version. */ getPackageVersionAsset(input: AWS.CodeArtifact.GetPackageVersionAssetRequest, options: SdkCallOptions): Promise; /** * Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the <description> element in the pom.xml file of a Maven package. The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText. */ getPackageVersionReadme(input: AWS.CodeArtifact.GetPackageVersionReadmeRequest, options: SdkCallOptions): Promise; /** * Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: maven npm nuget pypi */ getRepositoryEndpoint(input: AWS.CodeArtifact.GetRepositoryEndpointRequest, options: SdkCallOptions): Promise; /** * Returns the resource policy that is set on a repository. */ getRepositoryPermissionsPolicy(input: AWS.CodeArtifact.GetRepositoryPermissionsPolicyRequest, options: SdkCallOptions): Promise; /** * Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain. */ listDomains(input: AWS.CodeArtifact.ListDomainsRequest, options: SdkCallOptions): Promise; /** * Returns a list of AssetSummary objects for assets in a package version. */ listPackageVersionAssets(input: AWS.CodeArtifact.ListPackageVersionAssetsRequest, options: SdkCallOptions): Promise; /** * Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned. */ listPackageVersionDependencies(input: AWS.CodeArtifact.ListPackageVersionDependenciesRequest, options: SdkCallOptions): Promise; /** * Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. */ listPackageVersions(input: AWS.CodeArtifact.ListPackageVersionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of PackageSummary objects for packages in a repository that match the request parameters. */ listPackages(input: AWS.CodeArtifact.ListPackagesRequest, options: SdkCallOptions): Promise; /** * Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters. */ listRepositories(input: AWS.CodeArtifact.ListRepositoriesRequest, options: SdkCallOptions): Promise; /** * Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters. */ listRepositoriesInDomain(input: AWS.CodeArtifact.ListRepositoriesInDomainRequest, options: SdkCallOptions): Promise; /** * Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact. */ listTagsForResource(input: AWS.CodeArtifact.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Sets a resource policy on a domain that specifies permissions to access it. When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy. */ putDomainPermissionsPolicy(input: AWS.CodeArtifact.PutDomainPermissionsPolicyRequest, options: SdkCallOptions): Promise; /** * Sets the package origin configuration for a package. The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide. PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository. */ putPackageOriginConfiguration(input: AWS.CodeArtifact.PutPackageOriginConfigurationRequest, options: SdkCallOptions): Promise; /** * Sets the resource policy on a repository that specifies permissions to access it. When you call PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy. */ putRepositoryPermissionsPolicy(input: AWS.CodeArtifact.PutRepositoryPermissionsPolicyRequest, options: SdkCallOptions): Promise; /** * Adds or updates tags for a resource in CodeArtifact. */ tagResource(input: AWS.CodeArtifact.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource in CodeArtifact. */ untagResource(input: AWS.CodeArtifact.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions. */ updatePackageVersionsStatus(input: AWS.CodeArtifact.UpdatePackageVersionsStatusRequest, options: SdkCallOptions): Promise; /** * Update the properties of a repository. */ updateRepository(input: AWS.CodeArtifact.UpdateRepositoryRequest, options: SdkCallOptions): Promise; } export interface CodeBuild { /** * Deletes one or more builds. */ batchDeleteBuilds(input: AWS.CodeBuild.BatchDeleteBuildsInput, options: SdkCallOptions): Promise; /** * Retrieves information about one or more batch builds. */ batchGetBuildBatches(input: AWS.CodeBuild.BatchGetBuildBatchesInput, options: SdkCallOptions): Promise; /** * Gets information about one or more builds. */ batchGetBuilds(input: AWS.CodeBuild.BatchGetBuildsInput, options: SdkCallOptions): Promise; /** * Gets information about one or more build projects. */ batchGetProjects(input: AWS.CodeBuild.BatchGetProjectsInput, options: SdkCallOptions): Promise; /** * Returns an array of report groups. */ batchGetReportGroups(input: AWS.CodeBuild.BatchGetReportGroupsInput, options: SdkCallOptions): Promise; /** * Returns an array of reports. */ batchGetReports(input: AWS.CodeBuild.BatchGetReportsInput, options: SdkCallOptions): Promise; /** * Creates a build project. */ createProject(input: AWS.CodeBuild.CreateProjectInput, options: SdkCallOptions): Promise; /** * Creates a report group. A report group contains a collection of reports. */ createReportGroup(input: AWS.CodeBuild.CreateReportGroupInput, options: SdkCallOptions): Promise; /** * For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings. */ createWebhook(input: AWS.CodeBuild.CreateWebhookInput, options: SdkCallOptions): Promise; /** * Deletes a batch build. */ deleteBuildBatch(input: AWS.CodeBuild.DeleteBuildBatchInput, options: SdkCallOptions): Promise; /** * Deletes a build project. When you delete a project, its builds are not deleted. */ deleteProject(input: AWS.CodeBuild.DeleteProjectInput, options: SdkCallOptions): Promise; /** * Deletes a report. */ deleteReport(input: AWS.CodeBuild.DeleteReportInput, options: SdkCallOptions): Promise; /** * Deletes a report group. Before you delete a report group, you must delete its reports. */ deleteReportGroup(input: AWS.CodeBuild.DeleteReportGroupInput, options: SdkCallOptions): Promise; /** * Deletes a resource policy that is identified by its resource ARN. */ deleteResourcePolicy(input: AWS.CodeBuild.DeleteResourcePolicyInput, options: SdkCallOptions): Promise; /** * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. */ deleteSourceCredentials(input: AWS.CodeBuild.DeleteSourceCredentialsInput, options: SdkCallOptions): Promise; /** * For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository. */ deleteWebhook(input: AWS.CodeBuild.DeleteWebhookInput, options: SdkCallOptions): Promise; /** * Retrieves one or more code coverage reports. */ describeCodeCoverages(input: AWS.CodeBuild.DescribeCodeCoveragesInput, options: SdkCallOptions): Promise; /** * Returns a list of details about test cases for a report. */ describeTestCases(input: AWS.CodeBuild.DescribeTestCasesInput, options: SdkCallOptions): Promise; /** * Analyzes and accumulates test report values for the specified test reports. */ getReportGroupTrend(input: AWS.CodeBuild.GetReportGroupTrendInput, options: SdkCallOptions): Promise; /** * Gets a resource policy that is identified by its resource ARN. */ getResourcePolicy(input: AWS.CodeBuild.GetResourcePolicyInput, options: SdkCallOptions): Promise; /** * Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. */ importSourceCredentials(input: AWS.CodeBuild.ImportSourceCredentialsInput, options: SdkCallOptions): Promise; /** * Resets the cache for a project. */ invalidateProjectCache(input: AWS.CodeBuild.InvalidateProjectCacheInput, options: SdkCallOptions): Promise; /** * Retrieves the identifiers of your build batches in the current region. */ listBuildBatches(input: AWS.CodeBuild.ListBuildBatchesInput, options: SdkCallOptions): Promise; /** * Retrieves the identifiers of the build batches for a specific project. */ listBuildBatchesForProject(input: AWS.CodeBuild.ListBuildBatchesForProjectInput, options: SdkCallOptions): Promise; /** * Gets a list of build IDs, with each build ID representing a single build. */ listBuilds(input: AWS.CodeBuild.ListBuildsInput, options: SdkCallOptions): Promise; /** * Gets a list of build identifiers for the specified build project, with each build identifier representing a single build. */ listBuildsForProject(input: AWS.CodeBuild.ListBuildsForProjectInput, options: SdkCallOptions): Promise; /** * Gets information about Docker images that are managed by CodeBuild. */ listCuratedEnvironmentImages(input: AWS.CodeBuild.ListCuratedEnvironmentImagesInput, options: SdkCallOptions): Promise; /** * Gets a list of build project names, with each build project name representing a single build project. */ listProjects(input: AWS.CodeBuild.ListProjectsInput, options: SdkCallOptions): Promise; /** * Gets a list ARNs for the report groups in the current Amazon Web Services account. */ listReportGroups(input: AWS.CodeBuild.ListReportGroupsInput, options: SdkCallOptions): Promise; /** * Returns a list of ARNs for the reports in the current Amazon Web Services account. */ listReports(input: AWS.CodeBuild.ListReportsInput, options: SdkCallOptions): Promise; /** * Returns a list of ARNs for the reports that belong to a ReportGroup. */ listReportsForReportGroup(input: AWS.CodeBuild.ListReportsForReportGroupInput, options: SdkCallOptions): Promise; /** * Gets a list of projects that are shared with other Amazon Web Services accounts or users. */ listSharedProjects(input: AWS.CodeBuild.ListSharedProjectsInput, options: SdkCallOptions): Promise; /** * Gets a list of report groups that are shared with other Amazon Web Services accounts or users. */ listSharedReportGroups(input: AWS.CodeBuild.ListSharedReportGroupsInput, options: SdkCallOptions): Promise; /** * Returns a list of SourceCredentialsInfo objects. */ listSourceCredentials(input: AWS.CodeBuild.ListSourceCredentialsInput, options: SdkCallOptions): Promise; /** * Stores a resource policy for the ARN of a Project or ReportGroup object. */ putResourcePolicy(input: AWS.CodeBuild.PutResourcePolicyInput, options: SdkCallOptions): Promise; /** * Restarts a build. */ retryBuild(input: AWS.CodeBuild.RetryBuildInput, options: SdkCallOptions): Promise; /** * Restarts a failed batch build. Only batch builds that have failed can be retried. */ retryBuildBatch(input: AWS.CodeBuild.RetryBuildBatchInput, options: SdkCallOptions): Promise; /** * Starts running a build. */ startBuild(input: AWS.CodeBuild.StartBuildInput, options: SdkCallOptions): Promise; /** * Starts a batch build for a project. */ startBuildBatch(input: AWS.CodeBuild.StartBuildBatchInput, options: SdkCallOptions): Promise; /** * Attempts to stop running a build. */ stopBuild(input: AWS.CodeBuild.StopBuildInput, options: SdkCallOptions): Promise; /** * Stops a running batch build. */ stopBuildBatch(input: AWS.CodeBuild.StopBuildBatchInput, options: SdkCallOptions): Promise; /** * Changes the settings of a build project. */ updateProject(input: AWS.CodeBuild.UpdateProjectInput, options: SdkCallOptions): Promise; /** * Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide. The following should be kept in mind when making your projects public: All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public. All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are: Do not store sensitive values, especially Amazon Web Services access key IDs and secret access keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values. Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible. A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded. */ updateProjectVisibility(input: AWS.CodeBuild.UpdateProjectVisibilityInput, options: SdkCallOptions): Promise; /** * Updates a report group. */ updateReportGroup(input: AWS.CodeBuild.UpdateReportGroupInput, options: SdkCallOptions): Promise; /** * Updates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored. */ updateWebhook(input: AWS.CodeBuild.UpdateWebhookInput, options: SdkCallOptions): Promise; } export interface CodeCommit { /** * Creates an association between an approval rule template and a specified repository. Then, the next time a pull request is created in the repository where the destination reference (if specified) matches the destination reference (branch) for the pull request, an approval rule that matches the template conditions is automatically created for that pull request. If no destination references are specified in the template, an approval rule that matches the template contents is created for all pull requests in that repository. */ associateApprovalRuleTemplateWithRepository(input: AWS.CodeCommit.AssociateApprovalRuleTemplateWithRepositoryInput, options: SdkCallOptions): Promise<{}>; /** * Creates an association between an approval rule template and one or more specified repositories. */ batchAssociateApprovalRuleTemplateWithRepositories(input: AWS.CodeCommit.BatchAssociateApprovalRuleTemplateWithRepositoriesInput, options: SdkCallOptions): Promise; /** * Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy. */ batchDescribeMergeConflicts(input: AWS.CodeCommit.BatchDescribeMergeConflictsInput, options: SdkCallOptions): Promise; /** * Removes the association between an approval rule template and one or more specified repositories. */ batchDisassociateApprovalRuleTemplateFromRepositories(input: AWS.CodeCommit.BatchDisassociateApprovalRuleTemplateFromRepositoriesInput, options: SdkCallOptions): Promise; /** * Returns information about the contents of one or more commits in a repository. */ batchGetCommits(input: AWS.CodeCommit.BatchGetCommitsInput, options: SdkCallOptions): Promise; /** * Returns information about one or more repositories. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage. */ batchGetRepositories(input: AWS.CodeCommit.BatchGetRepositoriesInput, options: SdkCallOptions): Promise; /** * Creates a template for approval rules that can then be associated with one or more repositories in your AWS account. When you associate a template with a repository, AWS CodeCommit creates an approval rule that matches the conditions of the template for all pull requests that meet the conditions of the template. For more information, see AssociateApprovalRuleTemplateWithRepository. */ createApprovalRuleTemplate(input: AWS.CodeCommit.CreateApprovalRuleTemplateInput, options: SdkCallOptions): Promise; /** * Creates a branch in a repository and points the branch to a commit. Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation. */ createBranch(input: AWS.CodeCommit.CreateBranchInput, options: SdkCallOptions): Promise<{}>; /** * Creates a commit for a repository on the tip of a specified branch. */ createCommit(input: AWS.CodeCommit.CreateCommitInput, options: SdkCallOptions): Promise; /** * Creates a pull request in the specified repository. */ createPullRequest(input: AWS.CodeCommit.CreatePullRequestInput, options: SdkCallOptions): Promise; /** * Creates an approval rule for a pull request. */ createPullRequestApprovalRule(input: AWS.CodeCommit.CreatePullRequestApprovalRuleInput, options: SdkCallOptions): Promise; /** * Creates a new, empty repository. */ createRepository(input: AWS.CodeCommit.CreateRepositoryInput, options: SdkCallOptions): Promise; /** * Creates an unreferenced commit that represents the result of merging two branches using a specified merge strategy. This can help you determine the outcome of a potential merge. This API cannot be used with the fast-forward merge strategy because that strategy does not create a merge commit. This unreferenced merge commit can only be accessed using the GetCommit API or through git commands such as git fetch. To retrieve this commit, you must specify its commit ID or otherwise reference it. */ createUnreferencedMergeCommit(input: AWS.CodeCommit.CreateUnreferencedMergeCommitInput, options: SdkCallOptions): Promise; /** * Deletes a specified approval rule template. Deleting a template does not remove approval rules on pull requests already created with the template. */ deleteApprovalRuleTemplate(input: AWS.CodeCommit.DeleteApprovalRuleTemplateInput, options: SdkCallOptions): Promise; /** * Deletes a branch from a repository, unless that branch is the default branch for the repository. */ deleteBranch(input: AWS.CodeCommit.DeleteBranchInput, options: SdkCallOptions): Promise; /** * Deletes the content of a comment made on a change, file, or commit in a repository. */ deleteCommentContent(input: AWS.CodeCommit.DeleteCommentContentInput, options: SdkCallOptions): Promise; /** * Deletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file still exists in the commits earlier to the commit that contains the deletion. */ deleteFile(input: AWS.CodeCommit.DeleteFileInput, options: SdkCallOptions): Promise; /** * Deletes an approval rule from a specified pull request. Approval rules can be deleted from a pull request only if the pull request is open, and if the approval rule was created specifically for a pull request and not generated from an approval rule template associated with the repository where the pull request was created. You cannot delete an approval rule from a merged or closed pull request. */ deletePullRequestApprovalRule(input: AWS.CodeCommit.DeletePullRequestApprovalRuleInput, options: SdkCallOptions): Promise; /** * Deletes a repository. If a specified repository was already deleted, a null repository ID is returned. Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository fail. */ deleteRepository(input: AWS.CodeCommit.DeleteRepositoryInput, options: SdkCallOptions): Promise; /** * Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy. If the merge option for the attempted merge is specified as FAST_FORWARD_MERGE, an exception is thrown. */ describeMergeConflicts(input: AWS.CodeCommit.DescribeMergeConflictsInput, options: SdkCallOptions): Promise; /** * Returns information about one or more pull request events. */ describePullRequestEvents(input: AWS.CodeCommit.DescribePullRequestEventsInput, options: SdkCallOptions): Promise; /** * Removes the association between a template and a repository so that approval rules based on the template are not automatically created when pull requests are created in the specified repository. This does not delete any approval rules previously created for pull requests through the template association. */ disassociateApprovalRuleTemplateFromRepository(input: AWS.CodeCommit.DisassociateApprovalRuleTemplateFromRepositoryInput, options: SdkCallOptions): Promise<{}>; /** * Evaluates whether a pull request has met all the conditions specified in its associated approval rules. */ evaluatePullRequestApprovalRules(input: AWS.CodeCommit.EvaluatePullRequestApprovalRulesInput, options: SdkCallOptions): Promise; /** * Returns information about a specified approval rule template. */ getApprovalRuleTemplate(input: AWS.CodeCommit.GetApprovalRuleTemplateInput, options: SdkCallOptions): Promise; /** * Returns the base-64 encoded content of an individual blob in a repository. */ getBlob(input: AWS.CodeCommit.GetBlobInput, options: SdkCallOptions): Promise; /** * Returns information about a repository branch, including its name and the last commit ID. */ getBranch(input: AWS.CodeCommit.GetBranchInput, options: SdkCallOptions): Promise; /** * Returns the content of a comment made on a change, file, or commit in a repository. Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions. */ getComment(input: AWS.CodeCommit.GetCommentInput, options: SdkCallOptions): Promise; /** * Returns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count. */ getCommentReactions(input: AWS.CodeCommit.GetCommentReactionsInput, options: SdkCallOptions): Promise; /** * Returns information about comments made on the comparison between two commits. Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions. */ getCommentsForComparedCommit(input: AWS.CodeCommit.GetCommentsForComparedCommitInput, options: SdkCallOptions): Promise; /** * Returns comments made on a pull request. Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions. */ getCommentsForPullRequest(input: AWS.CodeCommit.GetCommentsForPullRequestInput, options: SdkCallOptions): Promise; /** * Returns information about a commit, including commit message and committer information. */ getCommit(input: AWS.CodeCommit.GetCommitInput, options: SdkCallOptions): Promise; /** * Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference). Results can be limited to a specified path. */ getDifferences(input: AWS.CodeCommit.GetDifferencesInput, options: SdkCallOptions): Promise; /** * Returns the base-64 encoded contents of a specified file and its metadata. */ getFile(input: AWS.CodeCommit.GetFileInput, options: SdkCallOptions): Promise; /** * Returns the contents of a specified folder in a repository. */ getFolder(input: AWS.CodeCommit.GetFolderInput, options: SdkCallOptions): Promise; /** * Returns information about a specified merge commit. */ getMergeCommit(input: AWS.CodeCommit.GetMergeCommitInput, options: SdkCallOptions): Promise; /** * Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository. */ getMergeConflicts(input: AWS.CodeCommit.GetMergeConflictsInput, options: SdkCallOptions): Promise; /** * Returns information about the merge options available for merging two specified branches. For details about why a merge option is not available, use GetMergeConflicts or DescribeMergeConflicts. */ getMergeOptions(input: AWS.CodeCommit.GetMergeOptionsInput, options: SdkCallOptions): Promise; /** * Gets information about a pull request in a specified repository. */ getPullRequest(input: AWS.CodeCommit.GetPullRequestInput, options: SdkCallOptions): Promise; /** * Gets information about the approval states for a specified pull request. Approval states only apply to pull requests that have one or more approval rules applied to them. */ getPullRequestApprovalStates(input: AWS.CodeCommit.GetPullRequestApprovalStatesInput, options: SdkCallOptions): Promise; /** * Returns information about whether approval rules have been set aside (overridden) for a pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request. */ getPullRequestOverrideState(input: AWS.CodeCommit.GetPullRequestOverrideStateInput, options: SdkCallOptions): Promise; /** * Returns information about a repository. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage. */ getRepository(input: AWS.CodeCommit.GetRepositoryInput, options: SdkCallOptions): Promise; /** * Gets information about triggers configured for a repository. */ getRepositoryTriggers(input: AWS.CodeCommit.GetRepositoryTriggersInput, options: SdkCallOptions): Promise; /** * Lists all approval rule templates in the specified AWS Region in your AWS account. If an AWS Region is not specified, the AWS Region where you are signed in is used. */ listApprovalRuleTemplates(input: AWS.CodeCommit.ListApprovalRuleTemplatesInput, options: SdkCallOptions): Promise; /** * Lists all approval rule templates that are associated with a specified repository. */ listAssociatedApprovalRuleTemplatesForRepository(input: AWS.CodeCommit.ListAssociatedApprovalRuleTemplatesForRepositoryInput, options: SdkCallOptions): Promise; /** * Gets information about one or more branches in a repository. */ listBranches(input: AWS.CodeCommit.ListBranchesInput, options: SdkCallOptions): Promise; /** * Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN. */ listPullRequests(input: AWS.CodeCommit.ListPullRequestsInput, options: SdkCallOptions): Promise; /** * Gets information about one or more repositories. */ listRepositories(input: AWS.CodeCommit.ListRepositoriesInput, options: SdkCallOptions): Promise; /** * Lists all repositories associated with the specified approval rule template. */ listRepositoriesForApprovalRuleTemplate(input: AWS.CodeCommit.ListRepositoriesForApprovalRuleTemplateInput, options: SdkCallOptions): Promise; /** * Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide. */ listTagsForResource(input: AWS.CodeCommit.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Merges two branches using the fast-forward merge strategy. */ mergeBranchesByFastForward(input: AWS.CodeCommit.MergeBranchesByFastForwardInput, options: SdkCallOptions): Promise; /** * Merges two branches using the squash merge strategy. */ mergeBranchesBySquash(input: AWS.CodeCommit.MergeBranchesBySquashInput, options: SdkCallOptions): Promise; /** * Merges two specified branches using the three-way merge strategy. */ mergeBranchesByThreeWay(input: AWS.CodeCommit.MergeBranchesByThreeWayInput, options: SdkCallOptions): Promise; /** * Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge strategy. If the merge is successful, it closes the pull request. */ mergePullRequestByFastForward(input: AWS.CodeCommit.MergePullRequestByFastForwardInput, options: SdkCallOptions): Promise; /** * Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the squash merge strategy. If the merge is successful, it closes the pull request. */ mergePullRequestBySquash(input: AWS.CodeCommit.MergePullRequestBySquashInput, options: SdkCallOptions): Promise; /** * Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the three-way merge strategy. If the merge is successful, it closes the pull request. */ mergePullRequestByThreeWay(input: AWS.CodeCommit.MergePullRequestByThreeWayInput, options: SdkCallOptions): Promise; /** * Sets aside (overrides) all approval rule requirements for a specified pull request. */ overridePullRequestApprovalRules(input: AWS.CodeCommit.OverridePullRequestApprovalRulesInput, options: SdkCallOptions): Promise<{}>; /** * Posts a comment on the comparison between two commits. */ postCommentForComparedCommit(input: AWS.CodeCommit.PostCommentForComparedCommitInput, options: SdkCallOptions): Promise; /** * Posts a comment on a pull request. */ postCommentForPullRequest(input: AWS.CodeCommit.PostCommentForPullRequestInput, options: SdkCallOptions): Promise; /** * Posts a comment in reply to an existing comment on a comparison between commits or a pull request. */ postCommentReply(input: AWS.CodeCommit.PostCommentReplyInput, options: SdkCallOptions): Promise; /** * Adds or updates a reaction to a specified comment for the user whose identity is used to make the request. You can only add or update a reaction for yourself. You cannot add, modify, or delete a reaction for another user. */ putCommentReaction(input: AWS.CodeCommit.PutCommentReactionInput, options: SdkCallOptions): Promise<{}>; /** * Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch. */ putFile(input: AWS.CodeCommit.PutFileInput, options: SdkCallOptions): Promise; /** * Replaces all triggers for a repository. Used to create or delete triggers. */ putRepositoryTriggers(input: AWS.CodeCommit.PutRepositoryTriggersInput, options: SdkCallOptions): Promise; /** * Adds or updates tags for a resource in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide. */ tagResource(input: AWS.CodeCommit.TagResourceInput, options: SdkCallOptions): Promise<{}>; /** * Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test sends data from the last commit. If no data is available, sample data is generated. */ testRepositoryTriggers(input: AWS.CodeCommit.TestRepositoryTriggersInput, options: SdkCallOptions): Promise; /** * Removes tags for a resource in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide. */ untagResource(input: AWS.CodeCommit.UntagResourceInput, options: SdkCallOptions): Promise<{}>; /** * Updates the content of an approval rule template. You can change the number of required approvals, the membership of the approval rule, and whether an approval pool is defined. */ updateApprovalRuleTemplateContent(input: AWS.CodeCommit.UpdateApprovalRuleTemplateContentInput, options: SdkCallOptions): Promise; /** * Updates the description for a specified approval rule template. */ updateApprovalRuleTemplateDescription(input: AWS.CodeCommit.UpdateApprovalRuleTemplateDescriptionInput, options: SdkCallOptions): Promise; /** * Updates the name of a specified approval rule template. */ updateApprovalRuleTemplateName(input: AWS.CodeCommit.UpdateApprovalRuleTemplateNameInput, options: SdkCallOptions): Promise; /** * Replaces the contents of a comment. */ updateComment(input: AWS.CodeCommit.UpdateCommentInput, options: SdkCallOptions): Promise; /** * Sets or changes the default branch name for the specified repository. If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change. */ updateDefaultBranch(input: AWS.CodeCommit.UpdateDefaultBranchInput, options: SdkCallOptions): Promise<{}>; /** * Updates the structure of an approval rule created specifically for a pull request. For example, you can change the number of required approvers and the approval pool for approvers. */ updatePullRequestApprovalRuleContent(input: AWS.CodeCommit.UpdatePullRequestApprovalRuleContentInput, options: SdkCallOptions): Promise; /** * Updates the state of a user's approval on a pull request. The user is derived from the signed-in account when the request is made. */ updatePullRequestApprovalState(input: AWS.CodeCommit.UpdatePullRequestApprovalStateInput, options: SdkCallOptions): Promise<{}>; /** * Replaces the contents of the description of a pull request. */ updatePullRequestDescription(input: AWS.CodeCommit.UpdatePullRequestDescriptionInput, options: SdkCallOptions): Promise; /** * Updates the status of a pull request. */ updatePullRequestStatus(input: AWS.CodeCommit.UpdatePullRequestStatusInput, options: SdkCallOptions): Promise; /** * Replaces the title of a pull request. */ updatePullRequestTitle(input: AWS.CodeCommit.UpdatePullRequestTitleInput, options: SdkCallOptions): Promise; /** * Sets or changes the comment or description for a repository. The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage. */ updateRepositoryDescription(input: AWS.CodeCommit.UpdateRepositoryDescriptionInput, options: SdkCallOptions): Promise<{}>; /** * Renames a repository. The repository name must be unique across the calling AWS account. Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix .git is prohibited. For more information about the limits on repository names, see Limits in the AWS CodeCommit User Guide. */ updateRepositoryName(input: AWS.CodeCommit.UpdateRepositoryNameInput, options: SdkCallOptions): Promise<{}>; } export interface CodeDeploy { /** * Adds tags to on-premises instances. */ addTagsToOnPremisesInstances(input: AWS.CodeDeploy.AddTagsToOnPremisesInstancesInput, options: SdkCallOptions): Promise<{}>; /** * Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25. */ batchGetApplicationRevisions(input: AWS.CodeDeploy.BatchGetApplicationRevisionsInput, options: SdkCallOptions): Promise; /** * Gets information about one or more applications. The maximum number of applications that can be returned is 100. */ batchGetApplications(input: AWS.CodeDeploy.BatchGetApplicationsInput, options: SdkCallOptions): Promise; /** * Gets information about one or more deployment groups. */ batchGetDeploymentGroups(input: AWS.CodeDeploy.BatchGetDeploymentGroupsInput, options: SdkCallOptions): Promise; /** * This method works, but is deprecated. Use BatchGetDeploymentTargets instead. Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25. */ batchGetDeploymentInstances(input: AWS.CodeDeploy.BatchGetDeploymentInstancesInput, options: SdkCallOptions): Promise; /** * Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25. The type of targets returned depends on the deployment's compute platform or deployment method: EC2/On-premises: Information about Amazon EC2 instance targets. Lambda: Information about Lambda functions targets. Amazon ECS: Information about Amazon ECS service targets. CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update. */ batchGetDeploymentTargets(input: AWS.CodeDeploy.BatchGetDeploymentTargetsInput, options: SdkCallOptions): Promise; /** * Gets information about one or more deployments. The maximum number of deployments that can be returned is 25. */ batchGetDeployments(input: AWS.CodeDeploy.BatchGetDeploymentsInput, options: SdkCallOptions): Promise; /** * Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25. */ batchGetOnPremisesInstances(input: AWS.CodeDeploy.BatchGetOnPremisesInstancesInput, options: SdkCallOptions): Promise; /** * For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.) */ continueDeployment(input: AWS.CodeDeploy.ContinueDeploymentInput, options: SdkCallOptions): Promise<{}>; /** * Creates an application. */ createApplication(input: AWS.CodeDeploy.CreateApplicationInput, options: SdkCallOptions): Promise; /** * Deploys an application revision through the specified deployment group. */ createDeployment(input: AWS.CodeDeploy.CreateDeploymentInput, options: SdkCallOptions): Promise; /** * Creates a deployment configuration. */ createDeploymentConfig(input: AWS.CodeDeploy.CreateDeploymentConfigInput, options: SdkCallOptions): Promise; /** * Creates a deployment group to which application revisions are deployed. */ createDeploymentGroup(input: AWS.CodeDeploy.CreateDeploymentGroupInput, options: SdkCallOptions): Promise; /** * Deletes an application. */ deleteApplication(input: AWS.CodeDeploy.DeleteApplicationInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted. */ deleteDeploymentConfig(input: AWS.CodeDeploy.DeleteDeploymentConfigInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a deployment group. */ deleteDeploymentGroup(input: AWS.CodeDeploy.DeleteDeploymentGroupInput, options: SdkCallOptions): Promise; /** * Deletes a GitHub account connection. */ deleteGitHubAccountToken(input: AWS.CodeDeploy.DeleteGitHubAccountTokenInput, options: SdkCallOptions): Promise; /** * Deletes resources linked to an external ID. */ deleteResourcesByExternalId(input: AWS.CodeDeploy.DeleteResourcesByExternalIdInput, options: SdkCallOptions): Promise; /** * Deregisters an on-premises instance. */ deregisterOnPremisesInstance(input: AWS.CodeDeploy.DeregisterOnPremisesInstanceInput, options: SdkCallOptions): Promise<{}>; /** * Gets information about an application. */ getApplication(input: AWS.CodeDeploy.GetApplicationInput, options: SdkCallOptions): Promise; /** * Gets information about an application revision. */ getApplicationRevision(input: AWS.CodeDeploy.GetApplicationRevisionInput, options: SdkCallOptions): Promise; /** * Gets information about a deployment. The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file. */ getDeployment(input: AWS.CodeDeploy.GetDeploymentInput, options: SdkCallOptions): Promise; /** * Gets information about a deployment configuration. */ getDeploymentConfig(input: AWS.CodeDeploy.GetDeploymentConfigInput, options: SdkCallOptions): Promise; /** * Gets information about a deployment group. */ getDeploymentGroup(input: AWS.CodeDeploy.GetDeploymentGroupInput, options: SdkCallOptions): Promise; /** * Gets information about an instance as part of a deployment. */ getDeploymentInstance(input: AWS.CodeDeploy.GetDeploymentInstanceInput, options: SdkCallOptions): Promise; /** * Returns information about a deployment target. */ getDeploymentTarget(input: AWS.CodeDeploy.GetDeploymentTargetInput, options: SdkCallOptions): Promise; /** * Gets information about an on-premises instance. */ getOnPremisesInstance(input: AWS.CodeDeploy.GetOnPremisesInstanceInput, options: SdkCallOptions): Promise; /** * Lists information about revisions for an application. */ listApplicationRevisions(input: AWS.CodeDeploy.ListApplicationRevisionsInput, options: SdkCallOptions): Promise; /** * Lists the applications registered with the IAM user or Amazon Web Services account. */ listApplications(input: AWS.CodeDeploy.ListApplicationsInput, options: SdkCallOptions): Promise; /** * Lists the deployment configurations with the IAM user or Amazon Web Services account. */ listDeploymentConfigs(input: AWS.CodeDeploy.ListDeploymentConfigsInput, options: SdkCallOptions): Promise; /** * Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account. */ listDeploymentGroups(input: AWS.CodeDeploy.ListDeploymentGroupsInput, options: SdkCallOptions): Promise; /** * The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda. Lists the instance for a deployment associated with the IAM user or Amazon Web Services account. */ listDeploymentInstances(input: AWS.CodeDeploy.ListDeploymentInstancesInput, options: SdkCallOptions): Promise; /** * Returns an array of target IDs that are associated a deployment. */ listDeploymentTargets(input: AWS.CodeDeploy.ListDeploymentTargetsInput, options: SdkCallOptions): Promise; /** * Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account. */ listDeployments(input: AWS.CodeDeploy.ListDeploymentsInput, options: SdkCallOptions): Promise; /** * Lists the names of stored connections to GitHub accounts. */ listGitHubAccountTokenNames(input: AWS.CodeDeploy.ListGitHubAccountTokenNamesInput, options: SdkCallOptions): Promise; /** * Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. */ listOnPremisesInstances(input: AWS.CodeDeploy.ListOnPremisesInstancesInput, options: SdkCallOptions): Promise; /** * Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources. */ listTagsForResource(input: AWS.CodeDeploy.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall, AfterInstall, AfterAllowTestTraffic, BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment. */ putLifecycleEventHookExecutionStatus(input: AWS.CodeDeploy.PutLifecycleEventHookExecutionStatusInput, options: SdkCallOptions): Promise; /** * Registers with CodeDeploy a revision for the specified application. */ registerApplicationRevision(input: AWS.CodeDeploy.RegisterApplicationRevisionInput, options: SdkCallOptions): Promise<{}>; /** * Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both. */ registerOnPremisesInstance(input: AWS.CodeDeploy.RegisterOnPremisesInstanceInput, options: SdkCallOptions): Promise<{}>; /** * Removes one or more tags from one or more on-premises instances. */ removeTagsFromOnPremisesInstances(input: AWS.CodeDeploy.RemoveTagsFromOnPremisesInstancesInput, options: SdkCallOptions): Promise<{}>; /** * In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete. */ skipWaitTimeForInstanceTermination(input: AWS.CodeDeploy.SkipWaitTimeForInstanceTerminationInput, options: SdkCallOptions): Promise<{}>; /** * Attempts to stop an ongoing deployment. */ stopDeployment(input: AWS.CodeDeploy.StopDeploymentInput, options: SdkCallOptions): Promise; /** * Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter. */ tagResource(input: AWS.CodeDeploy.TagResourceInput, options: SdkCallOptions): Promise; /** * Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input parameter. The tags are identified by the list of keys in the TagKeys input parameter. */ untagResource(input: AWS.CodeDeploy.UntagResourceInput, options: SdkCallOptions): Promise; /** * Changes the name of an application. */ updateApplication(input: AWS.CodeDeploy.UpdateApplicationInput, options: SdkCallOptions): Promise<{}>; /** * Changes information about a deployment group. */ updateDeploymentGroup(input: AWS.CodeDeploy.UpdateDeploymentGroupInput, options: SdkCallOptions): Promise; } export interface CodeGuruProfiler { /** * Add up to 2 anomaly notifications channels for a profiling group. */ addNotificationChannels(input: AWS.CodeGuruProfiler.AddNotificationChannelsRequest, options: SdkCallOptions): Promise; /** * Returns the time series of values for a requested list of frame metrics from a time period. */ batchGetFrameMetricData(input: AWS.CodeGuruProfiler.BatchGetFrameMetricDataRequest, options: SdkCallOptions): Promise; /** * Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell an agent whether to profile or not and for how long to return profiling data. */ configureAgent(input: AWS.CodeGuruProfiler.ConfigureAgentRequest, options: SdkCallOptions): Promise; /** * Creates a profiling group. */ createProfilingGroup(input: AWS.CodeGuruProfiler.CreateProfilingGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a profiling group. */ deleteProfilingGroup(input: AWS.CodeGuruProfiler.DeleteProfilingGroupRequest, options: SdkCallOptions): Promise; /** * Returns a ProfilingGroupDescription object that contains information about the requested profiling group. */ describeProfilingGroup(input: AWS.CodeGuruProfiler.DescribeProfilingGroupRequest, options: SdkCallOptions): Promise; /** * Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account. */ getFindingsReportAccountSummary(input: AWS.CodeGuruProfiler.GetFindingsReportAccountSummaryRequest, options: SdkCallOptions): Promise; /** * Get the current configuration for anomaly notifications for a profiling group. */ getNotificationConfiguration(input: AWS.CodeGuruProfiler.GetNotificationConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns the JSON-formatted resource-based policy on a profiling group. */ getPolicy(input: AWS.CodeGuruProfiler.GetPolicyRequest, options: SdkCallOptions): Promise; /** * Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles. <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol> */ getProfile(input: AWS.CodeGuruProfiler.GetProfileRequest, options: SdkCallOptions): Promise; /** * Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned. */ getRecommendations(input: AWS.CodeGuruProfiler.GetRecommendationsRequest, options: SdkCallOptions): Promise; /** * List the available reports for a given profiling group and time range. */ listFindingsReports(input: AWS.CodeGuruProfiler.ListFindingsReportsRequest, options: SdkCallOptions): Promise; /** * Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range. */ listProfileTimes(input: AWS.CodeGuruProfiler.ListProfileTimesRequest, options: SdkCallOptions): Promise; /** * Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects. */ listProfilingGroups(input: AWS.CodeGuruProfiler.ListProfilingGroupsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags that are assigned to a specified resource. */ listTagsForResource(input: AWS.CodeGuruProfiler.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile . */ postAgentProfile(input: AWS.CodeGuruProfiler.PostAgentProfileRequest, options: SdkCallOptions): Promise; /** * Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter. <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p> */ putPermission(input: AWS.CodeGuruProfiler.PutPermissionRequest, options: SdkCallOptions): Promise; /** * Remove one anomaly notifications channel for a profiling group. */ removeNotificationChannel(input: AWS.CodeGuruProfiler.RemoveNotificationChannelRequest, options: SdkCallOptions): Promise; /** * Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is agentPermission which grants ConfigureAgent and PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide, ConfigureAgent , and PostAgentProfile . */ removePermission(input: AWS.CodeGuruProfiler.RemovePermissionRequest, options: SdkCallOptions): Promise; /** * Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not. */ submitFeedback(input: AWS.CodeGuruProfiler.SubmitFeedbackRequest, options: SdkCallOptions): Promise; /** * Use to assign one or more tags to a resource. */ tagResource(input: AWS.CodeGuruProfiler.TagResourceRequest, options: SdkCallOptions): Promise; /** * Use to remove one or more tags from a resource. */ untagResource(input: AWS.CodeGuruProfiler.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a profiling group. */ updateProfilingGroup(input: AWS.CodeGuruProfiler.UpdateProfilingGroupRequest, options: SdkCallOptions): Promise; } export interface CodeGuruReviewer { /** * Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide. If you associate a CodeCommit or S3 repository, it must be in the same Amazon Web Services Region and Amazon Web Services account where its CodeGuru Reviewer code reviews are configured. Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Associate a repository in the Amazon CodeGuru Reviewer User Guide. You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide. */ associateRepository(input: AWS.CodeGuruReviewer.AssociateRepositoryRequest, options: SdkCallOptions): Promise; /** * Use to create a code review with a CodeReviewType of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. PullRequest code reviews are automatically triggered by a pull request. */ createCodeReview(input: AWS.CodeGuruReviewer.CreateCodeReviewRequest, options: SdkCallOptions): Promise; /** * Returns the metadata associated with the code review along with its status. */ describeCodeReview(input: AWS.CodeGuruReviewer.DescribeCodeReviewRequest, options: SdkCallOptions): Promise; /** * Describes the customer feedback for a CodeGuru Reviewer recommendation. */ describeRecommendationFeedback(input: AWS.CodeGuruReviewer.DescribeRecommendationFeedbackRequest, options: SdkCallOptions): Promise; /** * Returns a RepositoryAssociation object that contains information about the requested repository association. */ describeRepositoryAssociation(input: AWS.CodeGuruReviewer.DescribeRepositoryAssociationRequest, options: SdkCallOptions): Promise; /** * Removes the association between Amazon CodeGuru Reviewer and a repository. */ disassociateRepository(input: AWS.CodeGuruReviewer.DisassociateRepositoryRequest, options: SdkCallOptions): Promise; /** * Lists all the code reviews that the customer has created in the past 90 days. */ listCodeReviews(input: AWS.CodeGuruReviewer.ListCodeReviewsRequest, options: SdkCallOptions): Promise; /** * Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users. */ listRecommendationFeedback(input: AWS.CodeGuruReviewer.ListRecommendationFeedbackRequest, options: SdkCallOptions): Promise; /** * Returns the list of all recommendations for a completed code review. */ listRecommendations(input: AWS.CodeGuruReviewer.ListRecommendationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association. You can filter the returned list by ProviderType, Name, State, and Owner. */ listRepositoryAssociations(input: AWS.CodeGuruReviewer.ListRepositoryAssociationsRequest, options: SdkCallOptions): Promise; /** * Returns the list of tags associated with an associated repository resource. */ listTagsForResource(input: AWS.CodeGuruReviewer.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten. */ putRecommendationFeedback(input: AWS.CodeGuruReviewer.PutRecommendationFeedbackRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to an associated repository. */ tagResource(input: AWS.CodeGuruReviewer.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from an associated repository. */ untagResource(input: AWS.CodeGuruReviewer.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface CodePipeline { /** * Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only. */ acknowledgeJob(input: AWS.CodePipeline.AcknowledgeJobInput, options: SdkCallOptions): Promise; /** * Confirms a job worker has received the specified job. Used for partner actions only. */ acknowledgeThirdPartyJob(input: AWS.CodePipeline.AcknowledgeThirdPartyJobInput, options: SdkCallOptions): Promise; /** * Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. */ createCustomActionType(input: AWS.CodePipeline.CreateCustomActionTypeInput, options: SdkCallOptions): Promise; /** * Creates a pipeline. In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores. */ createPipeline(input: AWS.CodePipeline.CreatePipelineInput, options: SdkCallOptions): Promise; /** * Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field. */ deleteCustomActionType(input: AWS.CodePipeline.DeleteCustomActionTypeInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified pipeline. */ deletePipeline(input: AWS.CodePipeline.DeletePipelineInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL. */ deleteWebhook(input: AWS.CodePipeline.DeleteWebhookInput, options: SdkCallOptions): Promise; /** * Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub. */ deregisterWebhookWithThirdParty(input: AWS.CodePipeline.DeregisterWebhookWithThirdPartyInput, options: SdkCallOptions): Promise; /** * Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. */ disableStageTransition(input: AWS.CodePipeline.DisableStageTransitionInput, options: SdkCallOptions): Promise<{}>; /** * Enables artifacts in a pipeline to transition to a stage in a pipeline. */ enableStageTransition(input: AWS.CodePipeline.EnableStageTransitionInput, options: SdkCallOptions): Promise<{}>; /** * Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model. */ getActionType(input: AWS.CodePipeline.GetActionTypeInput, options: SdkCallOptions): Promise; /** * Returns information about a job. Used for custom actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action. */ getJobDetails(input: AWS.CodePipeline.GetJobDetailsInput, options: SdkCallOptions): Promise; /** * Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline. */ getPipeline(input: AWS.CodePipeline.GetPipelineInput, options: SdkCallOptions): Promise; /** * Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline. */ getPipelineExecution(input: AWS.CodePipeline.GetPipelineExecutionInput, options: SdkCallOptions): Promise; /** * Returns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state. */ getPipelineState(input: AWS.CodePipeline.GetPipelineStateInput, options: SdkCallOptions): Promise; /** * Requests the details of a job for a third party action. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action. */ getThirdPartyJobDetails(input: AWS.CodePipeline.GetThirdPartyJobDetailsInput, options: SdkCallOptions): Promise; /** * Lists the action executions that have occurred in a pipeline. */ listActionExecutions(input: AWS.CodePipeline.ListActionExecutionsInput, options: SdkCallOptions): Promise; /** * Gets a summary of all AWS CodePipeline action types associated with your account. */ listActionTypes(input: AWS.CodePipeline.ListActionTypesInput, options: SdkCallOptions): Promise; /** * Gets a summary of the most recent executions for a pipeline. */ listPipelineExecutions(input: AWS.CodePipeline.ListPipelineExecutionsInput, options: SdkCallOptions): Promise; /** * Gets a summary of all of the pipelines associated with your account. */ listPipelines(input: AWS.CodePipeline.ListPipelinesInput, options: SdkCallOptions): Promise; /** * Gets the set of key-value pairs (metadata) that are used to manage the resource. */ listTagsForResource(input: AWS.CodePipeline.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook. */ listWebhooks(input: AWS.CodePipeline.ListWebhooksInput, options: SdkCallOptions): Promise; /** * Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action. */ pollForJobs(input: AWS.CodePipeline.PollForJobsInput, options: SdkCallOptions): Promise; /** * Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. */ pollForThirdPartyJobs(input: AWS.CodePipeline.PollForThirdPartyJobsInput, options: SdkCallOptions): Promise; /** * Provides information to AWS CodePipeline about new revisions to a source. */ putActionRevision(input: AWS.CodePipeline.PutActionRevisionInput, options: SdkCallOptions): Promise; /** * Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected. */ putApprovalResult(input: AWS.CodePipeline.PutApprovalResultInput, options: SdkCallOptions): Promise; /** * Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only. */ putJobFailureResult(input: AWS.CodePipeline.PutJobFailureResultInput, options: SdkCallOptions): Promise<{}>; /** * Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only. */ putJobSuccessResult(input: AWS.CodePipeline.PutJobSuccessResultInput, options: SdkCallOptions): Promise<{}>; /** * Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only. */ putThirdPartyJobFailureResult(input: AWS.CodePipeline.PutThirdPartyJobFailureResultInput, options: SdkCallOptions): Promise<{}>; /** * Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only. */ putThirdPartyJobSuccessResult(input: AWS.CodePipeline.PutThirdPartyJobSuccessResultInput, options: SdkCallOptions): Promise<{}>; /** * Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL. */ putWebhook(input: AWS.CodePipeline.PutWebhookInput, options: SdkCallOptions): Promise; /** * Configures a connection between the webhook that was created and the external tool with events to be detected. */ registerWebhookWithThirdParty(input: AWS.CodePipeline.RegisterWebhookWithThirdPartyInput, options: SdkCallOptions): Promise; /** * Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again. */ retryStageExecution(input: AWS.CodePipeline.RetryStageExecutionInput, options: SdkCallOptions): Promise; /** * Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. */ startPipelineExecution(input: AWS.CodePipeline.StartPipelineExecutionInput, options: SdkCallOptions): Promise; /** * Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state. */ stopPipelineExecution(input: AWS.CodePipeline.StopPipelineExecutionInput, options: SdkCallOptions): Promise; /** * Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. */ tagResource(input: AWS.CodePipeline.TagResourceInput, options: SdkCallOptions): Promise; /** * Removes tags from an AWS resource. */ untagResource(input: AWS.CodePipeline.UntagResourceInput, options: SdkCallOptions): Promise; /** * Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and UpdateActionType to provide the full structure. */ updateActionType(input: AWS.CodePipeline.UpdateActionTypeInput, options: SdkCallOptions): Promise<{}>; /** * Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. */ updatePipeline(input: AWS.CodePipeline.UpdatePipelineInput, options: SdkCallOptions): Promise; } export interface CodeStar { /** * Adds an IAM user to the team for an AWS CodeStar project. */ associateTeamMember(input: AWS.CodeStar.AssociateTeamMemberRequest, options: SdkCallOptions): Promise; /** * Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created. */ createProject(input: AWS.CodeStar.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. */ createUserProfile(input: AWS.CodeStar.CreateUserProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project. */ deleteProject(input: AWS.CodeStar.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user. */ deleteUserProfile(input: AWS.CodeStar.DeleteUserProfileRequest, options: SdkCallOptions): Promise; /** * Describes a project and its resources. */ describeProject(input: AWS.CodeStar.DescribeProjectRequest, options: SdkCallOptions): Promise; /** * Describes a user in AWS CodeStar and the user attributes across all projects. */ describeUserProfile(input: AWS.CodeStar.DescribeUserProfileRequest, options: SdkCallOptions): Promise; /** * Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM. */ disassociateTeamMember(input: AWS.CodeStar.DisassociateTeamMemberRequest, options: SdkCallOptions): Promise; /** * Lists all projects in AWS CodeStar associated with your AWS account. */ listProjects(input: AWS.CodeStar.ListProjectsRequest, options: SdkCallOptions): Promise; /** * Lists resources associated with a project in AWS CodeStar. */ listResources(input: AWS.CodeStar.ListResourcesRequest, options: SdkCallOptions): Promise; /** * Gets the tags for a project. */ listTagsForProject(input: AWS.CodeStar.ListTagsForProjectRequest, options: SdkCallOptions): Promise; /** * Lists all team members associated with a project. */ listTeamMembers(input: AWS.CodeStar.ListTeamMembersRequest, options: SdkCallOptions): Promise; /** * Lists all the user profiles configured for your AWS account in AWS CodeStar. */ listUserProfiles(input: AWS.CodeStar.ListUserProfilesRequest, options: SdkCallOptions): Promise; /** * Adds tags to a project. */ tagProject(input: AWS.CodeStar.TagProjectRequest, options: SdkCallOptions): Promise; /** * Removes tags from a project. */ untagProject(input: AWS.CodeStar.UntagProjectRequest, options: SdkCallOptions): Promise; /** * Updates a project in AWS CodeStar. */ updateProject(input: AWS.CodeStar.UpdateProjectRequest, options: SdkCallOptions): Promise; /** * Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources. */ updateTeamMember(input: AWS.CodeStar.UpdateTeamMemberRequest, options: SdkCallOptions): Promise; /** * Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. */ updateUserProfile(input: AWS.CodeStar.UpdateUserProfileRequest, options: SdkCallOptions): Promise; } export interface CodeStarconnections { /** * Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console. */ createConnection(input: AWS.CodeStarconnections.CreateConnectionInput, options: SdkCallOptions): Promise; /** * Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider. A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console. */ createHost(input: AWS.CodeStarconnections.CreateHostInput, options: SdkCallOptions): Promise; /** * The connection to be deleted. */ deleteConnection(input: AWS.CodeStarconnections.DeleteConnectionInput, options: SdkCallOptions): Promise; /** * The host to be deleted. Before you delete a host, all connections associated to the host must be deleted. A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state. */ deleteHost(input: AWS.CodeStarconnections.DeleteHostInput, options: SdkCallOptions): Promise; /** * Returns the connection ARN and details such as status, owner, and provider type. */ getConnection(input: AWS.CodeStarconnections.GetConnectionInput, options: SdkCallOptions): Promise; /** * Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration. */ getHost(input: AWS.CodeStarconnections.GetHostInput, options: SdkCallOptions): Promise; /** * Lists the connections associated with your account. */ listConnections(input: AWS.CodeStarconnections.ListConnectionsInput, options: SdkCallOptions): Promise; /** * Lists the hosts associated with your account. */ listHosts(input: AWS.CodeStarconnections.ListHostsInput, options: SdkCallOptions): Promise; /** * Gets the set of key-value pairs (metadata) that are used to manage the resource. */ listTagsForResource(input: AWS.CodeStarconnections.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. */ tagResource(input: AWS.CodeStarconnections.TagResourceInput, options: SdkCallOptions): Promise; /** * Removes tags from an AWS resource. */ untagResource(input: AWS.CodeStarconnections.UntagResourceInput, options: SdkCallOptions): Promise; /** * Updates a specified host with the provided configurations. */ updateHost(input: AWS.CodeStarconnections.UpdateHostInput, options: SdkCallOptions): Promise; } export interface CodeStarNotifications { /** * Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive them. */ createNotificationRule(input: AWS.CodeStarNotifications.CreateNotificationRuleRequest, options: SdkCallOptions): Promise; /** * Deletes a notification rule for a resource. */ deleteNotificationRule(input: AWS.CodeStarNotifications.DeleteNotificationRuleRequest, options: SdkCallOptions): Promise; /** * Deletes a specified target for notifications. */ deleteTarget(input: AWS.CodeStarNotifications.DeleteTargetRequest, options: SdkCallOptions): Promise; /** * Returns information about a specified notification rule. */ describeNotificationRule(input: AWS.CodeStarNotifications.DescribeNotificationRuleRequest, options: SdkCallOptions): Promise; /** * Returns information about the event types available for configuring notifications. */ listEventTypes(input: AWS.CodeStarNotifications.ListEventTypesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the notification rules for an Amazon Web Services account. */ listNotificationRules(input: AWS.CodeStarNotifications.ListNotificationRulesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags associated with a notification rule. */ listTagsForResource(input: AWS.CodeStarNotifications.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of the notification rule targets for an Amazon Web Services account. */ listTargets(input: AWS.CodeStarNotifications.ListTargetsRequest, options: SdkCallOptions): Promise; /** * Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered. */ subscribe(input: AWS.CodeStarNotifications.SubscribeRequest, options: SdkCallOptions): Promise; /** * Associates a set of provided tags with a notification rule. */ tagResource(input: AWS.CodeStarNotifications.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered. */ unsubscribe(input: AWS.CodeStarNotifications.UnsubscribeRequest, options: SdkCallOptions): Promise; /** * Removes the association between one or more provided tags and a notification rule. */ untagResource(input: AWS.CodeStarNotifications.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications. To add or remove tags for a notification rule, you must use TagResource and UntagResource. */ updateNotificationRule(input: AWS.CodeStarNotifications.UpdateNotificationRuleRequest, options: SdkCallOptions): Promise; } export interface CognitoIdentity { /** * Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com You must use AWS Developer credentials to call this API. */ createIdentityPool(input: AWS.CognitoIdentity.CreateIdentityPoolInput, options: SdkCallOptions): Promise; /** * Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. You must use AWS Developer credentials to call this API. */ deleteIdentities(input: AWS.CognitoIdentity.DeleteIdentitiesInput, options: SdkCallOptions): Promise; /** * Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use AWS Developer credentials to call this API. */ deleteIdentityPool(input: AWS.CognitoIdentity.DeleteIdentityPoolInput, options: SdkCallOptions): Promise<{}>; /** * Returns metadata related to the given identity, including when the identity was created and any associated linked logins. You must use AWS Developer credentials to call this API. */ describeIdentity(input: AWS.CognitoIdentity.DescribeIdentityInput, options: SdkCallOptions): Promise; /** * Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. You must use AWS Developer credentials to call this API. */ describeIdentityPool(input: AWS.CognitoIdentity.DescribeIdentityPoolInput, options: SdkCallOptions): Promise; /** * Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. This is a public API. You do not need any credentials to call this API. */ getCredentialsForIdentity(input: AWS.CognitoIdentity.GetCredentialsForIdentityInput, options: SdkCallOptions): Promise; /** * Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. This is a public API. You do not need any credentials to call this API. */ getId(input: AWS.CognitoIdentity.GetIdInput, options: SdkCallOptions): Promise; /** * Gets the roles for an identity pool. You must use AWS Developer credentials to call this API. */ getIdentityPoolRoles(input: AWS.CognitoIdentity.GetIdentityPoolRolesInput, options: SdkCallOptions): Promise; /** * Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. The OpenID token is valid for 10 minutes. This is a public API. You do not need any credentials to call this API. */ getOpenIdToken(input: AWS.CognitoIdentity.GetOpenIdTokenInput, options: SdkCallOptions): Promise; /** * Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId. You must use AWS Developer credentials to call this API. */ getOpenIdTokenForDeveloperIdentity(input: AWS.CognitoIdentity.GetOpenIdTokenForDeveloperIdentityInput, options: SdkCallOptions): Promise; /** * Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes. */ getPrincipalTagAttributeMap(input: AWS.CognitoIdentity.GetPrincipalTagAttributeMapInput, options: SdkCallOptions): Promise; /** * Lists the identities in an identity pool. You must use AWS Developer credentials to call this API. */ listIdentities(input: AWS.CognitoIdentity.ListIdentitiesInput, options: SdkCallOptions): Promise; /** * Lists all of the Cognito identity pools registered for your account. You must use AWS Developer credentials to call this API. */ listIdentityPools(input: AWS.CognitoIdentity.ListIdentityPoolsInput, options: SdkCallOptions): Promise; /** * Lists the tags that are assigned to an Amazon Cognito identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account. */ listTagsForResource(input: AWS.CognitoIdentity.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown. LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication. You must use AWS Developer credentials to call this API. */ lookupDeveloperIdentity(input: AWS.CognitoIdentity.LookupDeveloperIdentityInput, options: SdkCallOptions): Promise; /** * Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown. You must use AWS Developer credentials to call this API. */ mergeDeveloperIdentities(input: AWS.CognitoIdentity.MergeDeveloperIdentitiesInput, options: SdkCallOptions): Promise; /** * Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action. You must use AWS Developer credentials to call this API. */ setIdentityPoolRoles(input: AWS.CognitoIdentity.SetIdentityPoolRolesInput, options: SdkCallOptions): Promise<{}>; /** * You can use this operation to use default (username and clientID) attribute or custom attribute mappings. */ setPrincipalTagAttributeMap(input: AWS.CognitoIdentity.SetPrincipalTagAttributeMapInput, options: SdkCallOptions): Promise; /** * Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags. */ tagResource(input: AWS.CognitoIdentity.TagResourceInput, options: SdkCallOptions): Promise; /** * Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. You must use AWS Developer credentials to call this API. */ unlinkDeveloperIdentity(input: AWS.CognitoIdentity.UnlinkDeveloperIdentityInput, options: SdkCallOptions): Promise<{}>; /** * Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. This is a public API. You do not need any credentials to call this API. */ unlinkIdentity(input: AWS.CognitoIdentity.UnlinkIdentityInput, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account */ untagResource(input: AWS.CognitoIdentity.UntagResourceInput, options: SdkCallOptions): Promise; /** * Updates an identity pool. You must use AWS Developer credentials to call this API. */ updateIdentityPool(input: AWS.CognitoIdentity.IdentityPool, options: SdkCallOptions): Promise; } export interface CognitoIdentityServiceProvider { /** * Adds additional user attributes to the user pool schema. */ addCustomAttributes(input: AWS.CognitoIdentityServiceProvider.AddCustomAttributesRequest, options: SdkCallOptions): Promise; /** * Adds the specified user to the specified group. Calling this action requires developer credentials. */ adminAddUserToGroup(input: AWS.CognitoIdentityServiceProvider.AdminAddUserToGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Confirms user registration as an admin without using a confirmation code. Works on any user. Calling this action requires developer credentials. */ adminConfirmSignUp(input: AWS.CognitoIdentityServiceProvider.AdminConfirmSignUpRequest, options: SdkCallOptions): Promise; /** * Creates a new user in the specified user pool. If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS). This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password. AdminCreateUser requires developer credentials. */ adminCreateUser(input: AWS.CognitoIdentityServiceProvider.AdminCreateUserRequest, options: SdkCallOptions): Promise; /** * Deletes a user as an administrator. Works on any user. Calling this action requires developer credentials. */ adminDeleteUser(input: AWS.CognitoIdentityServiceProvider.AdminDeleteUserRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the user attributes in a user pool as an administrator. Works on any user. Calling this action requires developer credentials. */ adminDeleteUserAttributes(input: AWS.CognitoIdentityServiceProvider.AdminDeleteUserAttributesRequest, options: SdkCallOptions): Promise; /** * Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser. This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion. */ adminDisableProviderForUser(input: AWS.CognitoIdentityServiceProvider.AdminDisableProviderForUserRequest, options: SdkCallOptions): Promise; /** * Disables the specified user. Calling this action requires developer credentials. */ adminDisableUser(input: AWS.CognitoIdentityServiceProvider.AdminDisableUserRequest, options: SdkCallOptions): Promise; /** * Enables the specified user as an administrator. Works on any user. Calling this action requires developer credentials. */ adminEnableUser(input: AWS.CognitoIdentityServiceProvider.AdminEnableUserRequest, options: SdkCallOptions): Promise; /** * Forgets the device, as an administrator. Calling this action requires developer credentials. */ adminForgetDevice(input: AWS.CognitoIdentityServiceProvider.AdminForgetDeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Gets the device, as an administrator. Calling this action requires developer credentials. */ adminGetDevice(input: AWS.CognitoIdentityServiceProvider.AdminGetDeviceRequest, options: SdkCallOptions): Promise; /** * Gets the specified user by user name in a user pool as an administrator. Works on any user. Calling this action requires developer credentials. */ adminGetUser(input: AWS.CognitoIdentityServiceProvider.AdminGetUserRequest, options: SdkCallOptions): Promise; /** * Initiates the authentication flow, as an administrator. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. Calling this action requires developer credentials. */ adminInitiateAuth(input: AWS.CognitoIdentityServiceProvider.AdminInitiateAuthRequest, options: SdkCallOptions): Promise; /** * Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account. The maximum number of federated identities linked to a user is five. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner. This action is administrative and requires developer credentials. */ adminLinkProviderForUser(input: AWS.CognitoIdentityServiceProvider.AdminLinkProviderForUserRequest, options: SdkCallOptions): Promise; /** * Lists devices, as an administrator. Calling this action requires developer credentials. */ adminListDevices(input: AWS.CognitoIdentityServiceProvider.AdminListDevicesRequest, options: SdkCallOptions): Promise; /** * Lists the groups that the user belongs to. Calling this action requires developer credentials. */ adminListGroupsForUser(input: AWS.CognitoIdentityServiceProvider.AdminListGroupsForUserRequest, options: SdkCallOptions): Promise; /** * A history of user activity and any risks detected as part of Amazon Cognito advanced security. */ adminListUserAuthEvents(input: AWS.CognitoIdentityServiceProvider.AdminListUserAuthEventsRequest, options: SdkCallOptions): Promise; /** * Removes the specified user from the specified group. Calling this action requires developer credentials. */ adminRemoveUserFromGroup(input: AWS.CognitoIdentityServiceProvider.AdminRemoveUserFromGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. Calling this action requires developer credentials. */ adminResetUserPassword(input: AWS.CognitoIdentityServiceProvider.AdminResetUserPasswordRequest, options: SdkCallOptions): Promise; /** * Responds to an authentication challenge, as an administrator. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. Calling this action requires developer credentials. */ adminRespondToAuthChallenge(input: AWS.CognitoIdentityServiceProvider.AdminRespondToAuthChallengeRequest, options: SdkCallOptions): Promise; /** * The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. */ adminSetUserMFAPreference(input: AWS.CognitoIdentityServiceProvider.AdminSetUserMFAPreferenceRequest, options: SdkCallOptions): Promise; /** * Sets the specified user's password in a user pool as an administrator. Works on any user. The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password. Once the user has set a new password, or the password is permanent, the user status is set to Confirmed. */ adminSetUserPassword(input: AWS.CognitoIdentityServiceProvider.AdminSetUserPasswordRequest, options: SdkCallOptions): Promise; /** * This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead. */ adminSetUserSettings(input: AWS.CognitoIdentityServiceProvider.AdminSetUserSettingsRequest, options: SdkCallOptions): Promise; /** * Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. */ adminUpdateAuthEventFeedback(input: AWS.CognitoIdentityServiceProvider.AdminUpdateAuthEventFeedbackRequest, options: SdkCallOptions): Promise; /** * Updates the device status as an administrator. Calling this action requires developer credentials. */ adminUpdateDeviceStatus(input: AWS.CognitoIdentityServiceProvider.AdminUpdateDeviceStatusRequest, options: SdkCallOptions): Promise; /** * Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. Calling this action requires developer credentials. */ adminUpdateUserAttributes(input: AWS.CognitoIdentityServiceProvider.AdminUpdateUserAttributesRequest, options: SdkCallOptions): Promise; /** * Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour. Calling this action requires developer credentials. */ adminUserGlobalSignOut(input: AWS.CognitoIdentityServiceProvider.AdminUserGlobalSignOutRequest, options: SdkCallOptions): Promise; /** * Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito. Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken. After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP. */ associateSoftwareToken(input: AWS.CognitoIdentityServiceProvider.AssociateSoftwareTokenRequest, options: SdkCallOptions): Promise; /** * Changes the password for a specified user in a user pool. */ changePassword(input: AWS.CognitoIdentityServiceProvider.ChangePasswordRequest, options: SdkCallOptions): Promise; /** * Confirms tracking of the device. This API call is the call that begins device tracking. */ confirmDevice(input: AWS.CognitoIdentityServiceProvider.ConfirmDeviceRequest, options: SdkCallOptions): Promise; /** * Allows a user to enter a confirmation code to reset a forgotten password. */ confirmForgotPassword(input: AWS.CognitoIdentityServiceProvider.ConfirmForgotPasswordRequest, options: SdkCallOptions): Promise; /** * Confirms registration of a new user. */ confirmSignUp(input: AWS.CognitoIdentityServiceProvider.ConfirmSignUpRequest, options: SdkCallOptions): Promise; /** * Creates a new group in the specified user pool. Calling this action requires developer credentials. */ createGroup(input: AWS.CognitoIdentityServiceProvider.CreateGroupRequest, options: SdkCallOptions): Promise; /** * Creates an IdP for a user pool. */ createIdentityProvider(input: AWS.CognitoIdentityServiceProvider.CreateIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Creates a new OAuth2.0 resource server and defines custom scopes within it. */ createResourceServer(input: AWS.CognitoIdentityServiceProvider.CreateResourceServerRequest, options: SdkCallOptions): Promise; /** * Creates the user import job. */ createUserImportJob(input: AWS.CognitoIdentityServiceProvider.CreateUserImportJobRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon Cognito user pool and sets the password policy for the pool. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ createUserPool(input: AWS.CognitoIdentityServiceProvider.CreateUserPoolRequest, options: SdkCallOptions): Promise; /** * Creates the user pool client. When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken. */ createUserPoolClient(input: AWS.CognitoIdentityServiceProvider.CreateUserPoolClientRequest, options: SdkCallOptions): Promise; /** * Creates a new domain for a user pool. */ createUserPoolDomain(input: AWS.CognitoIdentityServiceProvider.CreateUserPoolDomainRequest, options: SdkCallOptions): Promise; /** * Deletes a group. Calling this action requires developer credentials. */ deleteGroup(input: AWS.CognitoIdentityServiceProvider.DeleteGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an IdP for a user pool. */ deleteIdentityProvider(input: AWS.CognitoIdentityServiceProvider.DeleteIdentityProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a resource server. */ deleteResourceServer(input: AWS.CognitoIdentityServiceProvider.DeleteResourceServerRequest, options: SdkCallOptions): Promise<{}>; /** * Allows a user to delete himself or herself. */ deleteUser(input: AWS.CognitoIdentityServiceProvider.DeleteUserRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the attributes for a user. */ deleteUserAttributes(input: AWS.CognitoIdentityServiceProvider.DeleteUserAttributesRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Amazon Cognito user pool. */ deleteUserPool(input: AWS.CognitoIdentityServiceProvider.DeleteUserPoolRequest, options: SdkCallOptions): Promise<{}>; /** * Allows the developer to delete the user pool client. */ deleteUserPoolClient(input: AWS.CognitoIdentityServiceProvider.DeleteUserPoolClientRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a domain for a user pool. */ deleteUserPoolDomain(input: AWS.CognitoIdentityServiceProvider.DeleteUserPoolDomainRequest, options: SdkCallOptions): Promise; /** * Gets information about a specific IdP. */ describeIdentityProvider(input: AWS.CognitoIdentityServiceProvider.DescribeIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Describes a resource server. */ describeResourceServer(input: AWS.CognitoIdentityServiceProvider.DescribeResourceServerRequest, options: SdkCallOptions): Promise; /** * Describes the risk configuration. */ describeRiskConfiguration(input: AWS.CognitoIdentityServiceProvider.DescribeRiskConfigurationRequest, options: SdkCallOptions): Promise; /** * Describes the user import job. */ describeUserImportJob(input: AWS.CognitoIdentityServiceProvider.DescribeUserImportJobRequest, options: SdkCallOptions): Promise; /** * Returns the configuration information and metadata of the specified user pool. */ describeUserPool(input: AWS.CognitoIdentityServiceProvider.DescribeUserPoolRequest, options: SdkCallOptions): Promise; /** * Client method for returning the configuration information and metadata of the specified user pool app client. */ describeUserPoolClient(input: AWS.CognitoIdentityServiceProvider.DescribeUserPoolClientRequest, options: SdkCallOptions): Promise; /** * Gets information about a domain. */ describeUserPoolDomain(input: AWS.CognitoIdentityServiceProvider.DescribeUserPoolDomainRequest, options: SdkCallOptions): Promise; /** * Forgets the specified device. */ forgetDevice(input: AWS.CognitoIdentityServiceProvider.ForgetDeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ forgotPassword(input: AWS.CognitoIdentityServiceProvider.ForgotPasswordRequest, options: SdkCallOptions): Promise; /** * Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job. */ getCSVHeader(input: AWS.CognitoIdentityServiceProvider.GetCSVHeaderRequest, options: SdkCallOptions): Promise; /** * Gets the device. */ getDevice(input: AWS.CognitoIdentityServiceProvider.GetDeviceRequest, options: SdkCallOptions): Promise; /** * Gets a group. Calling this action requires developer credentials. */ getGroup(input: AWS.CognitoIdentityServiceProvider.GetGroupRequest, options: SdkCallOptions): Promise; /** * Gets the specified IdP. */ getIdentityProviderByIdentifier(input: AWS.CognitoIdentityServiceProvider.GetIdentityProviderByIdentifierRequest, options: SdkCallOptions): Promise; /** * This method takes a user pool ID, and returns the signing certificate. */ getSigningCertificate(input: AWS.CognitoIdentityServiceProvider.GetSigningCertificateRequest, options: SdkCallOptions): Promise; /** * Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned. */ getUICustomization(input: AWS.CognitoIdentityServiceProvider.GetUICustomizationRequest, options: SdkCallOptions): Promise; /** * Gets the user attributes and metadata for a user. */ getUser(input: AWS.CognitoIdentityServiceProvider.GetUserRequest, options: SdkCallOptions): Promise; /** * Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ getUserAttributeVerificationCode(input: AWS.CognitoIdentityServiceProvider.GetUserAttributeVerificationCodeRequest, options: SdkCallOptions): Promise; /** * Gets the user pool multi-factor authentication (MFA) configuration. */ getUserPoolMfaConfig(input: AWS.CognitoIdentityServiceProvider.GetUserPoolMfaConfigRequest, options: SdkCallOptions): Promise; /** * Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until their expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour. */ globalSignOut(input: AWS.CognitoIdentityServiceProvider.GlobalSignOutRequest, options: SdkCallOptions): Promise; /** * Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ initiateAuth(input: AWS.CognitoIdentityServiceProvider.InitiateAuthRequest, options: SdkCallOptions): Promise; /** * Lists the sign-in devices that Amazon Cognito has registered to the current user. */ listDevices(input: AWS.CognitoIdentityServiceProvider.ListDevicesRequest, options: SdkCallOptions): Promise; /** * Lists the groups associated with a user pool. Calling this action requires developer credentials. */ listGroups(input: AWS.CognitoIdentityServiceProvider.ListGroupsRequest, options: SdkCallOptions): Promise; /** * Lists information about all IdPs for a user pool. */ listIdentityProviders(input: AWS.CognitoIdentityServiceProvider.ListIdentityProvidersRequest, options: SdkCallOptions): Promise; /** * Lists the resource servers for a user pool. */ listResourceServers(input: AWS.CognitoIdentityServiceProvider.ListResourceServersRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are assigned to an Amazon Cognito user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account. */ listTagsForResource(input: AWS.CognitoIdentityServiceProvider.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the user import jobs. */ listUserImportJobs(input: AWS.CognitoIdentityServiceProvider.ListUserImportJobsRequest, options: SdkCallOptions): Promise; /** * Lists the clients that have been created for the specified user pool. */ listUserPoolClients(input: AWS.CognitoIdentityServiceProvider.ListUserPoolClientsRequest, options: SdkCallOptions): Promise; /** * Lists the user pools associated with an Amazon Web Services account. */ listUserPools(input: AWS.CognitoIdentityServiceProvider.ListUserPoolsRequest, options: SdkCallOptions): Promise; /** * Lists the users in the Amazon Cognito user pool. */ listUsers(input: AWS.CognitoIdentityServiceProvider.ListUsersRequest, options: SdkCallOptions): Promise; /** * Lists the users in the specified group. Calling this action requires developer credentials. */ listUsersInGroup(input: AWS.CognitoIdentityServiceProvider.ListUsersInGroupRequest, options: SdkCallOptions): Promise; /** * Resends the confirmation (for confirmation of registration) to a specific user in the user pool. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ resendConfirmationCode(input: AWS.CognitoIdentityServiceProvider.ResendConfirmationCodeRequest, options: SdkCallOptions): Promise; /** * Responds to the authentication challenge. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ respondToAuthChallenge(input: AWS.CognitoIdentityServiceProvider.RespondToAuthChallengeRequest, options: SdkCallOptions): Promise; /** * Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs. */ revokeToken(input: AWS.CognitoIdentityServiceProvider.RevokeTokenRequest, options: SdkCallOptions): Promise; /** * Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode. */ setRiskConfiguration(input: AWS.CognitoIdentityServiceProvider.SetRiskConfigurationRequest, options: SdkCallOptions): Promise; /** * Sets the user interface (UI) customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration. To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error. */ setUICustomization(input: AWS.CognitoIdentityServiceProvider.SetUICustomizationRequest, options: SdkCallOptions): Promise; /** * Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool. */ setUserMFAPreference(input: AWS.CognitoIdentityServiceProvider.SetUserMFAPreferenceRequest, options: SdkCallOptions): Promise; /** * Sets the user pool multi-factor authentication (MFA) configuration. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ setUserPoolMfaConfig(input: AWS.CognitoIdentityServiceProvider.SetUserPoolMfaConfigRequest, options: SdkCallOptions): Promise; /** * This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead. */ setUserSettings(input: AWS.CognitoIdentityServiceProvider.SetUserSettingsRequest, options: SdkCallOptions): Promise; /** * Registers the user in the specified user pool and creates a user name, password, and user attributes. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ signUp(input: AWS.CognitoIdentityServiceProvider.SignUpRequest, options: SdkCallOptions): Promise; /** * Starts the user import. */ startUserImportJob(input: AWS.CognitoIdentityServiceProvider.StartUserImportJobRequest, options: SdkCallOptions): Promise; /** * Stops the user import job. */ stopUserImportJob(input: AWS.CognitoIdentityServiceProvider.StopUserImportJobRequest, options: SdkCallOptions): Promise; /** * Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool, and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags. */ tagResource(input: AWS.CognitoIdentityServiceProvider.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account. */ untagResource(input: AWS.CognitoIdentityServiceProvider.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. */ updateAuthEventFeedback(input: AWS.CognitoIdentityServiceProvider.UpdateAuthEventFeedbackRequest, options: SdkCallOptions): Promise; /** * Updates the device status. */ updateDeviceStatus(input: AWS.CognitoIdentityServiceProvider.UpdateDeviceStatusRequest, options: SdkCallOptions): Promise; /** * Updates the specified group with the specified attributes. Calling this action requires developer credentials. */ updateGroup(input: AWS.CognitoIdentityServiceProvider.UpdateGroupRequest, options: SdkCallOptions): Promise; /** * Updates IdP information for a user pool. */ updateIdentityProvider(input: AWS.CognitoIdentityServiceProvider.UpdateIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Updates the name and scopes of resource server. All other fields are read-only. If you don't provide a value for an attribute, it is set to the default value. */ updateResourceServer(input: AWS.CognitoIdentityServiceProvider.UpdateResourceServerRequest, options: SdkCallOptions): Promise; /** * Allows a user to update a specific attribute (one at a time). This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ updateUserAttributes(input: AWS.CognitoIdentityServiceProvider.UpdateUserAttributesRequest, options: SdkCallOptions): Promise; /** * Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. */ updateUserPool(input: AWS.CognitoIdentityServiceProvider.UpdateUserPoolRequest, options: SdkCallOptions): Promise; /** * Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient. If you don't provide a value for an attribute, it will be set to the default value. You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken. */ updateUserPoolClient(input: AWS.CognitoIdentityServiceProvider.UpdateUserPoolClientRequest, options: SdkCallOptions): Promise; /** * Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI. */ updateUserPoolDomain(input: AWS.CognitoIdentityServiceProvider.UpdateUserPoolDomainRequest, options: SdkCallOptions): Promise; /** * Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both. */ verifySoftwareToken(input: AWS.CognitoIdentityServiceProvider.VerifySoftwareTokenRequest, options: SdkCallOptions): Promise; /** * Verifies the specified user attributes in the user pool. If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType. */ verifyUserAttribute(input: AWS.CognitoIdentityServiceProvider.VerifyUserAttributeRequest, options: SdkCallOptions): Promise; } export interface CognitoSync { /** * Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. */ bulkPublish(input: AWS.CognitoSync.BulkPublishRequest, options: SdkCallOptions): Promise; /** * Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. */ deleteDataset(input: AWS.CognitoSync.DeleteDatasetRequest, options: SdkCallOptions): Promise; /** * Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. */ describeDataset(input: AWS.CognitoSync.DescribeDatasetRequest, options: SdkCallOptions): Promise; /** * Gets usage details (for example, data storage) about a particular identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. */ describeIdentityPoolUsage(input: AWS.CognitoSync.DescribeIdentityPoolUsageRequest, options: SdkCallOptions): Promise; /** * Gets usage information for an identity, including number of datasets and data usage. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. */ describeIdentityUsage(input: AWS.CognitoSync.DescribeIdentityUsageRequest, options: SdkCallOptions): Promise; /** * Get the status of the last BulkPublish operation for an identity pool.This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. */ getBulkPublishDetails(input: AWS.CognitoSync.GetBulkPublishDetailsRequest, options: SdkCallOptions): Promise; /** * Gets the events and the corresponding Lambda functions associated with an identity pool.This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. */ getCognitoEvents(input: AWS.CognitoSync.GetCognitoEventsRequest, options: SdkCallOptions): Promise; /** * Gets the configuration settings of an identity pool.This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. */ getIdentityPoolConfiguration(input: AWS.CognitoSync.GetIdentityPoolConfigurationRequest, options: SdkCallOptions): Promise; /** * Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. */ listDatasets(input: AWS.CognitoSync.ListDatasetsRequest, options: SdkCallOptions): Promise; /** * Gets a list of identity pools registered with Cognito. ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. */ listIdentityPoolUsage(input: AWS.CognitoSync.ListIdentityPoolUsageRequest, options: SdkCallOptions): Promise; /** * Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. */ listRecords(input: AWS.CognitoSync.ListRecordsRequest, options: SdkCallOptions): Promise; /** * Registers a device to receive push sync notifications.This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. */ registerDevice(input: AWS.CognitoSync.RegisterDeviceRequest, options: SdkCallOptions): Promise; /** * Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. */ setCognitoEvents(input: AWS.CognitoSync.SetCognitoEventsRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the necessary configuration for push sync.This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. */ setIdentityPoolConfiguration(input: AWS.CognitoSync.SetIdentityPoolConfigurationRequest, options: SdkCallOptions): Promise; /** * Subscribes to receive notifications when a dataset is modified by another device.This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. */ subscribeToDataset(input: AWS.CognitoSync.SubscribeToDatasetRequest, options: SdkCallOptions): Promise; /** * Unsubscribes from receiving notifications when a dataset is modified by another device.This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. */ unsubscribeFromDataset(input: AWS.CognitoSync.UnsubscribeFromDatasetRequest, options: SdkCallOptions): Promise; /** * Posts updates to records and adds and deletes records for a dataset and user. The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. */ updateRecords(input: AWS.CognitoSync.UpdateRecordsRequest, options: SdkCallOptions): Promise; } export interface Comprehend { /** * Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. */ batchDetectDominantLanguage(input: AWS.Comprehend.BatchDetectDominantLanguageRequest, options: SdkCallOptions): Promise; /** * Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide. */ batchDetectEntities(input: AWS.Comprehend.BatchDetectEntitiesRequest, options: SdkCallOptions): Promise; /** * Detects the key noun phrases found in a batch of documents. */ batchDetectKeyPhrases(input: AWS.Comprehend.BatchDetectKeyPhrasesRequest, options: SdkCallOptions): Promise; /** * Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one. */ batchDetectSentiment(input: AWS.Comprehend.BatchDetectSentimentRequest, options: SdkCallOptions): Promise; /** * Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide. */ batchDetectSyntax(input: AWS.Comprehend.BatchDetectSyntaxRequest, options: SdkCallOptions): Promise; /** * Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents. For more information about targeted sentiment, see Targeted sentiment. */ batchDetectTargetedSentiment(input: AWS.Comprehend.BatchDetectTargetedSentimentRequest, options: SdkCallOptions): Promise; /** * Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint. */ classifyDocument(input: AWS.Comprehend.ClassifyDocumentRequest, options: SdkCallOptions): Promise; /** * Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number. */ containsPiiEntities(input: AWS.Comprehend.ContainsPiiEntitiesRequest, options: SdkCallOptions): Promise; /** * Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide. */ createDocumentClassifier(input: AWS.Comprehend.CreateDocumentClassifierRequest, options: SdkCallOptions): Promise; /** * Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints. */ createEndpoint(input: AWS.Comprehend.CreateEndpointRequest, options: SdkCallOptions): Promise; /** * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API. */ createEntityRecognizer(input: AWS.Comprehend.CreateEntityRecognizerRequest, options: SdkCallOptions): Promise; /** * Deletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use. */ deleteDocumentClassifier(input: AWS.Comprehend.DeleteDocumentClassifierRequest, options: SdkCallOptions): Promise; /** * Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints. */ deleteEndpoint(input: AWS.Comprehend.DeleteEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use. */ deleteEntityRecognizer(input: AWS.Comprehend.DeleteEntityRecognizerRequest, options: SdkCallOptions): Promise; /** * Deletes a resource-based policy that is attached to a custom model. */ deleteResourcePolicy(input: AWS.Comprehend.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a document classification job. Use this operation to get the status of a classification job. */ describeDocumentClassificationJob(input: AWS.Comprehend.DescribeDocumentClassificationJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a document classifier. */ describeDocumentClassifier(input: AWS.Comprehend.DescribeDocumentClassifierRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job. */ describeDominantLanguageDetectionJob(input: AWS.Comprehend.DescribeDominantLanguageDetectionJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints. */ describeEndpoint(input: AWS.Comprehend.DescribeEndpointRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job. */ describeEntitiesDetectionJob(input: AWS.Comprehend.DescribeEntitiesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on. */ describeEntityRecognizer(input: AWS.Comprehend.DescribeEntityRecognizerRequest, options: SdkCallOptions): Promise; /** * Gets the status and details of an events detection job. */ describeEventsDetectionJob(input: AWS.Comprehend.DescribeEventsDetectionJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job. */ describeKeyPhrasesDetectionJob(input: AWS.Comprehend.DescribeKeyPhrasesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status. */ describePiiEntitiesDetectionJob(input: AWS.Comprehend.DescribePiiEntitiesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy. */ describeResourcePolicy(input: AWS.Comprehend.DescribeResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job. */ describeSentimentDetectionJob(input: AWS.Comprehend.DescribeSentimentDetectionJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job. */ describeTargetedSentimentDetectionJob(input: AWS.Comprehend.DescribeTargetedSentimentDetectionJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job. */ describeTopicsDetectionJob(input: AWS.Comprehend.DescribeTopicsDetectionJobRequest, options: SdkCallOptions): Promise; /** * Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. */ detectDominantLanguage(input: AWS.Comprehend.DetectDominantLanguageRequest, options: SdkCallOptions): Promise; /** * Inspects text for named entities, and returns information about them. For more information, about named entities, see Entities in the Comprehend Developer Guide. */ detectEntities(input: AWS.Comprehend.DetectEntitiesRequest, options: SdkCallOptions): Promise; /** * Detects the key noun phrases found in the text. */ detectKeyPhrases(input: AWS.Comprehend.DetectKeyPhrasesRequest, options: SdkCallOptions): Promise; /** * Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them. */ detectPiiEntities(input: AWS.Comprehend.DetectPiiEntitiesRequest, options: SdkCallOptions): Promise; /** * Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE). */ detectSentiment(input: AWS.Comprehend.DetectSentimentRequest, options: SdkCallOptions): Promise; /** * Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide. */ detectSyntax(input: AWS.Comprehend.DetectSyntaxRequest, options: SdkCallOptions): Promise; /** * Inspects the input text and returns a sentiment analysis for each entity identified in the text. For more information about targeted sentiment, see Targeted sentiment. */ detectTargetedSentiment(input: AWS.Comprehend.DetectTargetedSentimentRequest, options: SdkCallOptions): Promise; /** * Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one. If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region. */ importModel(input: AWS.Comprehend.ImportModelRequest, options: SdkCallOptions): Promise; /** * Gets a list of the documentation classification jobs that you have submitted. */ listDocumentClassificationJobs(input: AWS.Comprehend.ListDocumentClassificationJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of summaries of the document classifiers that you have created */ listDocumentClassifierSummaries(input: AWS.Comprehend.ListDocumentClassifierSummariesRequest, options: SdkCallOptions): Promise; /** * Gets a list of the document classifiers that you have created. */ listDocumentClassifiers(input: AWS.Comprehend.ListDocumentClassifiersRequest, options: SdkCallOptions): Promise; /** * Gets a list of the dominant language detection jobs that you have submitted. */ listDominantLanguageDetectionJobs(input: AWS.Comprehend.ListDominantLanguageDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints. */ listEndpoints(input: AWS.Comprehend.ListEndpointsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the entity detection jobs that you have submitted. */ listEntitiesDetectionJobs(input: AWS.Comprehend.ListEntitiesDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of summaries for the entity recognizers that you have created. */ listEntityRecognizerSummaries(input: AWS.Comprehend.ListEntityRecognizerSummariesRequest, options: SdkCallOptions): Promise; /** * Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. The results of this list are not in any particular order. Please get the list and sort locally if needed. */ listEntityRecognizers(input: AWS.Comprehend.ListEntityRecognizersRequest, options: SdkCallOptions): Promise; /** * Gets a list of the events detection jobs that you have submitted. */ listEventsDetectionJobs(input: AWS.Comprehend.ListEventsDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Get a list of key phrase detection jobs that you have submitted. */ listKeyPhrasesDetectionJobs(input: AWS.Comprehend.ListKeyPhrasesDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the PII entity detection jobs that you have submitted. */ listPiiEntitiesDetectionJobs(input: AWS.Comprehend.ListPiiEntitiesDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of sentiment detection jobs that you have submitted. */ listSentimentDetectionJobs(input: AWS.Comprehend.ListSentimentDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Lists all tags associated with a given Amazon Comprehend resource. */ listTagsForResource(input: AWS.Comprehend.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Gets a list of targeted sentiment detection jobs that you have submitted. */ listTargetedSentimentDetectionJobs(input: AWS.Comprehend.ListTargetedSentimentDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the topic detection jobs that you have submitted. */ listTopicsDetectionJobs(input: AWS.Comprehend.ListTopicsDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account. */ putResourcePolicy(input: AWS.Comprehend.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous document classification job. Use the operation to track the progress of the job. */ startDocumentClassificationJob(input: AWS.Comprehend.StartDocumentClassificationJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job. */ startDominantLanguageDetectionJob(input: AWS.Comprehend.StartDominantLanguageDetectionJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job. This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity. */ startEntitiesDetectionJob(input: AWS.Comprehend.StartEntitiesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous event detection job for a collection of documents. */ startEventsDetectionJob(input: AWS.Comprehend.StartEventsDetectionJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job. */ startKeyPhrasesDetectionJob(input: AWS.Comprehend.StartKeyPhrasesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous PII entity detection job for a collection of documents. */ startPiiEntitiesDetectionJob(input: AWS.Comprehend.StartPiiEntitiesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job. */ startSentimentDetectionJob(input: AWS.Comprehend.StartSentimentDetectionJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job. */ startTargetedSentimentDetectionJob(input: AWS.Comprehend.StartTargetedSentimentDetectionJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job. */ startTopicsDetectionJob(input: AWS.Comprehend.StartTopicsDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops a dominant language detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. */ stopDominantLanguageDetectionJob(input: AWS.Comprehend.StopDominantLanguageDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops an entities detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. */ stopEntitiesDetectionJob(input: AWS.Comprehend.StopEntitiesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops an events detection job in progress. */ stopEventsDetectionJob(input: AWS.Comprehend.StopEventsDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops a key phrases detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. */ stopKeyPhrasesDetectionJob(input: AWS.Comprehend.StopKeyPhrasesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops a PII entities detection job in progress. */ stopPiiEntitiesDetectionJob(input: AWS.Comprehend.StopPiiEntitiesDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops a sentiment detection job in progress. If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. */ stopSentimentDetectionJob(input: AWS.Comprehend.StopSentimentDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops a targeted sentiment detection job in progress. If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location. */ stopTargetedSentimentDetectionJob(input: AWS.Comprehend.StopTargetedSentimentDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops a document classifier training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body. */ stopTrainingDocumentClassifier(input: AWS.Comprehend.StopTrainingDocumentClassifierRequest, options: SdkCallOptions): Promise; /** * Stops an entity recognizer training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body. */ stopTrainingEntityRecognizer(input: AWS.Comprehend.StopTrainingEntityRecognizerRequest, options: SdkCallOptions): Promise; /** * Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. */ tagResource(input: AWS.Comprehend.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a specific tag associated with an Amazon Comprehend resource. */ untagResource(input: AWS.Comprehend.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates information about the specified endpoint. For information about endpoints, see Managing endpoints. */ updateEndpoint(input: AWS.Comprehend.UpdateEndpointRequest, options: SdkCallOptions): Promise; } export interface ComprehendMedical { /** * Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job. */ describeEntitiesDetectionV2Job(input: AWS.ComprehendMedical.DescribeEntitiesDetectionV2JobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job. */ describeICD10CMInferenceJob(input: AWS.ComprehendMedical.DescribeICD10CMInferenceJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job. */ describePHIDetectionJob(input: AWS.ComprehendMedical.DescribePHIDetectionJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job. */ describeRxNormInferenceJob(input: AWS.ComprehendMedical.DescribeRxNormInferenceJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job. */ describeSNOMEDCTInferenceJob(input: AWS.ComprehendMedical.DescribeSNOMEDCTInferenceJobRequest, options: SdkCallOptions): Promise; /** * The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead. Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information . */ detectEntities(input: AWS.ComprehendMedical.DetectEntitiesRequest, options: SdkCallOptions): Promise; /** * Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts. The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications. The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types. */ detectEntitiesV2(input: AWS.ComprehendMedical.DetectEntitiesV2Request, options: SdkCallOptions): Promise; /** * Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts. */ detectPHI(input: AWS.ComprehendMedical.DetectPHIRequest, options: SdkCallOptions): Promise; /** * InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts. */ inferICD10CM(input: AWS.ComprehendMedical.InferICD10CMRequest, options: SdkCallOptions): Promise; /** * InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts. */ inferRxNorm(input: AWS.ComprehendMedical.InferRxNormRequest, options: SdkCallOptions): Promise; /** * InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology */ inferSNOMEDCT(input: AWS.ComprehendMedical.InferSNOMEDCTRequest, options: SdkCallOptions): Promise; /** * Gets a list of medical entity detection jobs that you have submitted. */ listEntitiesDetectionV2Jobs(input: AWS.ComprehendMedical.ListEntitiesDetectionV2JobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of InferICD10CM jobs that you have submitted. */ listICD10CMInferenceJobs(input: AWS.ComprehendMedical.ListICD10CMInferenceJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of protected health information (PHI) detection jobs that you have submitted. */ listPHIDetectionJobs(input: AWS.ComprehendMedical.ListPHIDetectionJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of InferRxNorm jobs that you have submitted. */ listRxNormInferenceJobs(input: AWS.ComprehendMedical.ListRxNormInferenceJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of InferSNOMEDCT jobs a user has submitted. */ listSNOMEDCTInferenceJobs(input: AWS.ComprehendMedical.ListSNOMEDCTInferenceJobsRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job. */ startEntitiesDetectionV2Job(input: AWS.ComprehendMedical.StartEntitiesDetectionV2JobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a job. */ startICD10CMInferenceJob(input: AWS.ComprehendMedical.StartICD10CMInferenceJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job. */ startPHIDetectionJob(input: AWS.ComprehendMedical.StartPHIDetectionJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the DescribeRxNormInferenceJob operation to track the status of a job. */ startRxNormInferenceJob(input: AWS.ComprehendMedical.StartRxNormInferenceJobRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job. */ startSNOMEDCTInferenceJob(input: AWS.ComprehendMedical.StartSNOMEDCTInferenceJobRequest, options: SdkCallOptions): Promise; /** * Stops a medical entities detection job in progress. */ stopEntitiesDetectionV2Job(input: AWS.ComprehendMedical.StopEntitiesDetectionV2JobRequest, options: SdkCallOptions): Promise; /** * Stops an InferICD10CM inference job in progress. */ stopICD10CMInferenceJob(input: AWS.ComprehendMedical.StopICD10CMInferenceJobRequest, options: SdkCallOptions): Promise; /** * Stops a protected health information (PHI) detection job in progress. */ stopPHIDetectionJob(input: AWS.ComprehendMedical.StopPHIDetectionJobRequest, options: SdkCallOptions): Promise; /** * Stops an InferRxNorm inference job in progress. */ stopRxNormInferenceJob(input: AWS.ComprehendMedical.StopRxNormInferenceJobRequest, options: SdkCallOptions): Promise; /** * Stops an InferSNOMEDCT inference job in progress. */ stopSNOMEDCTInferenceJob(input: AWS.ComprehendMedical.StopSNOMEDCTInferenceJobRequest, options: SdkCallOptions): Promise; } export interface ComputeOptimizer { /** * Deletes a recommendation preference, such as enhanced infrastructure metrics. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide. */ deleteRecommendationPreferences(input: AWS.ComputeOptimizer.DeleteRecommendationPreferencesRequest, options: SdkCallOptions): Promise; /** * Describes recommendation export jobs created in the last seven days. Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs. */ describeRecommendationExportJobs(input: AWS.ComputeOptimizer.DescribeRecommendationExportJobsRequest, options: SdkCallOptions): Promise; /** * Exports optimization recommendations for Auto Scaling groups. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Auto Scaling group export job in progress per Amazon Web Services Region. */ exportAutoScalingGroupRecommendations(input: AWS.ComputeOptimizer.ExportAutoScalingGroupRecommendationsRequest, options: SdkCallOptions): Promise; /** * Exports optimization recommendations for Amazon EBS volumes. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region. */ exportEBSVolumeRecommendations(input: AWS.ComputeOptimizer.ExportEBSVolumeRecommendationsRequest, options: SdkCallOptions): Promise; /** * Exports optimization recommendations for Amazon EC2 instances. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region. */ exportEC2InstanceRecommendations(input: AWS.ComputeOptimizer.ExportEC2InstanceRecommendationsRequest, options: SdkCallOptions): Promise; /** * Exports optimization recommendations for Lambda functions. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Lambda function export job in progress per Amazon Web Services Region. */ exportLambdaFunctionRecommendations(input: AWS.ComputeOptimizer.ExportLambdaFunctionRecommendationsRequest, options: SdkCallOptions): Promise; /** * Returns Auto Scaling group recommendations. Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. */ getAutoScalingGroupRecommendations(input: AWS.ComputeOptimizer.GetAutoScalingGroupRecommendationsRequest, options: SdkCallOptions): Promise; /** * Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations. Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. */ getEBSVolumeRecommendations(input: AWS.ComputeOptimizer.GetEBSVolumeRecommendationsRequest, options: SdkCallOptions): Promise; /** * Returns Amazon EC2 instance recommendations. Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. */ getEC2InstanceRecommendations(input: AWS.ComputeOptimizer.GetEC2InstanceRecommendationsRequest, options: SdkCallOptions): Promise; /** * Returns the projected utilization metrics of Amazon EC2 instance recommendations. The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. */ getEC2RecommendationProjectedMetrics(input: AWS.ComputeOptimizer.GetEC2RecommendationProjectedMetricsRequest, options: SdkCallOptions): Promise; /** * Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics. Considers all applicable preferences that you might have set at the resource, account, and organization level. When you create a recommendation preference, you can set its status to Active or Inactive. Use this action to view the recommendation preferences that are in effect, or Active. */ getEffectiveRecommendationPreferences(input: AWS.ComputeOptimizer.GetEffectiveRecommendationPreferencesRequest, options: SdkCallOptions): Promise; /** * Returns the enrollment (opt in) status of an account to the Compute Optimizer service. If the account is the management account of an organization, this action also confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information about the enrollment status of member accounts of an organization. */ getEnrollmentStatus(input: AWS.ComputeOptimizer.GetEnrollmentStatusRequest, options: SdkCallOptions): Promise; /** * Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account. To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action. */ getEnrollmentStatusesForOrganization(input: AWS.ComputeOptimizer.GetEnrollmentStatusesForOrganizationRequest, options: SdkCallOptions): Promise; /** * Returns Lambda function recommendations. Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. */ getLambdaFunctionRecommendations(input: AWS.ComputeOptimizer.GetLambdaFunctionRecommendationsRequest, options: SdkCallOptions): Promise; /** * Returns existing recommendation preferences, such as enhanced infrastructure metrics. Use the scope parameter to specify which preferences to return. You can specify to return preferences for an organization, a specific account ID, or a specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN). For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide. */ getRecommendationPreferences(input: AWS.ComputeOptimizer.GetRecommendationPreferencesRequest, options: SdkCallOptions): Promise; /** * Returns the optimization findings for an account. It returns the number of: Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized. Auto Scaling groups in an account that are NotOptimized, or Optimized. Amazon EBS volumes in an account that are NotOptimized, or Optimized. Lambda functions in an account that are NotOptimized, or Optimized. */ getRecommendationSummaries(input: AWS.ComputeOptimizer.GetRecommendationSummariesRequest, options: SdkCallOptions): Promise; /** * Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide. */ putRecommendationPreferences(input: AWS.ComputeOptimizer.PutRecommendationPreferencesRequest, options: SdkCallOptions): Promise; /** * Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service. If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization. You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide. When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide. */ updateEnrollmentStatus(input: AWS.ComputeOptimizer.UpdateEnrollmentStatusRequest, options: SdkCallOptions): Promise; } export interface ConfigService { /** * Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list. The API does not return results for deleted resources. The API does not return tags and relationships. */ batchGetAggregateResourceConfig(input: AWS.ConfigService.BatchGetAggregateResourceConfigRequest, options: SdkCallOptions): Promise; /** * Returns the BaseConfigurationItem for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list. The API does not return results for deleted resources. The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response. */ batchGetResourceConfig(input: AWS.ConfigService.BatchGetResourceConfigRequest, options: SdkCallOptions): Promise; /** * Deletes the authorization granted to the specified configuration aggregator account in a specified region. */ deleteAggregationAuthorization(input: AWS.ConfigService.DeleteAggregationAuthorizationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Config rule and all of its evaluation results. Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException. You can check the state of a rule by using the DescribeConfigRules request. */ deleteConfigRule(input: AWS.ConfigService.DeleteConfigRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified configuration aggregator and the aggregated data associated with the aggregator. */ deleteConfigurationAggregator(input: AWS.ConfigService.DeleteConfigurationAggregatorRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the configuration recorder. After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder. This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the Config console until you create a new configuration recorder. */ deleteConfigurationRecorder(input: AWS.ConfigService.DeleteConfigurationRecorderRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack. Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state. */ deleteConformancePack(input: AWS.ConfigService.DeleteConformancePackRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the delivery channel. Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action. */ deleteDeliveryChannel(input: AWS.ConfigService.DeleteDeliveryChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule. */ deleteEvaluationResults(input: AWS.ConfigService.DeleteEvaluationResultsRequest, options: SdkCallOptions): Promise; /** * Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization. Only a master account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state. */ deleteOrganizationConfigRule(input: AWS.ConfigService.DeleteOrganizationConfigRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization. Only a master account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state. */ deleteOrganizationConformancePack(input: AWS.ConfigService.DeleteOrganizationConformancePackRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes pending authorization requests for a specified aggregator account in a specified region. */ deletePendingAggregationRequest(input: AWS.ConfigService.DeletePendingAggregationRequestRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the remediation configuration. */ deleteRemediationConfiguration(input: AWS.ConfigService.DeleteRemediationConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes one or more remediation exceptions mentioned in the resource keys. Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared. */ deleteRemediationExceptions(input: AWS.ConfigService.DeleteRemediationExceptionsRequest, options: SdkCallOptions): Promise; /** * Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History. */ deleteResourceConfig(input: AWS.ConfigService.DeleteResourceConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the retention configuration. */ deleteRetentionConfiguration(input: AWS.ConfigService.DeleteRetentionConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region. */ deleteStoredQuery(input: AWS.ConfigService.DeleteStoredQueryRequest, options: SdkCallOptions): Promise; /** * Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified. Notification of the start of the delivery. Notification of the completion of the delivery, if the delivery was successfully completed. Notification of delivery failure, if the delivery failed. */ deliverConfigSnapshot(input: AWS.ConfigService.DeliverConfigSnapshotRequest, options: SdkCallOptions): Promise; /** * Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. */ describeAggregateComplianceByConfigRules(input: AWS.ConfigService.DescribeAggregateComplianceByConfigRulesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. */ describeAggregateComplianceByConformancePacks(input: AWS.ConfigService.DescribeAggregateComplianceByConformancePacksRequest, options: SdkCallOptions): Promise; /** * Returns a list of authorizations granted to various aggregator accounts and regions. */ describeAggregationAuthorizations(input: AWS.ConfigService.DescribeAggregationAuthorizationsRequest, options: SdkCallOptions): Promise; /** * Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule. A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply. If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions: Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission. The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope. */ describeComplianceByConfigRule(input: AWS.ConfigService.DescribeComplianceByConfigRuleRequest, options: SdkCallOptions): Promise; /** * Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with. A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource: Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission. The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope. */ describeComplianceByResource(input: AWS.ConfigService.DescribeComplianceByResourceRequest, options: SdkCallOptions): Promise; /** * Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure. */ describeConfigRuleEvaluationStatus(input: AWS.ConfigService.DescribeConfigRuleEvaluationStatusRequest, options: SdkCallOptions): Promise; /** * Returns details about your Config rules. */ describeConfigRules(input: AWS.ConfigService.DescribeConfigRulesRequest, options: SdkCallOptions): Promise; /** * Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message. */ describeConfigurationAggregatorSourcesStatus(input: AWS.ConfigService.DescribeConfigurationAggregatorSourcesStatusRequest, options: SdkCallOptions): Promise; /** * Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account. */ describeConfigurationAggregators(input: AWS.ConfigService.DescribeConfigurationAggregatorsRequest, options: SdkCallOptions): Promise; /** * Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account. Currently, you can specify only one configuration recorder per region in your account. */ describeConfigurationRecorderStatus(input: AWS.ConfigService.DescribeConfigurationRecorderStatusRequest, options: SdkCallOptions): Promise; /** * Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account. Currently, you can specify only one configuration recorder per region in your account. */ describeConfigurationRecorders(input: AWS.ConfigService.DescribeConfigurationRecordersRequest, options: SdkCallOptions): Promise; /** * Returns compliance details for each rule in that conformance pack. You must provide exact rule names. */ describeConformancePackCompliance(input: AWS.ConfigService.DescribeConformancePackComplianceRequest, options: SdkCallOptions): Promise; /** * Provides one or more conformance packs deployment status. If there are no conformance packs then you will see an empty result. */ describeConformancePackStatus(input: AWS.ConfigService.DescribeConformancePackStatusRequest, options: SdkCallOptions): Promise; /** * Returns a list of one or more conformance packs. */ describeConformancePacks(input: AWS.ConfigService.DescribeConformancePacksRequest, options: SdkCallOptions): Promise; /** * Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account. */ describeDeliveryChannelStatus(input: AWS.ConfigService.DescribeDeliveryChannelStatusRequest, options: SdkCallOptions): Promise; /** * Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account. */ describeDeliveryChannels(input: AWS.ConfigService.DescribeDeliveryChannelsRequest, options: SdkCallOptions): Promise; /** * Provides organization Config rule deployment status for an organization. The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules. */ describeOrganizationConfigRuleStatuses(input: AWS.ConfigService.DescribeOrganizationConfigRuleStatusesRequest, options: SdkCallOptions): Promise; /** * Returns a list of organization Config rules. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules. For accounts within an organzation If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs. */ describeOrganizationConfigRules(input: AWS.ConfigService.DescribeOrganizationConfigRulesRequest, options: SdkCallOptions): Promise; /** * Provides organization conformance pack deployment status for an organization. The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs. */ describeOrganizationConformancePackStatuses(input: AWS.ConfigService.DescribeOrganizationConformancePackStatusesRequest, options: SdkCallOptions): Promise; /** * Returns a list of organization conformance packs. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs. For accounts within an organzation If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs. */ describeOrganizationConformancePacks(input: AWS.ConfigService.DescribeOrganizationConformancePacksRequest, options: SdkCallOptions): Promise; /** * Returns a list of all pending aggregation requests. */ describePendingAggregationRequests(input: AWS.ConfigService.DescribePendingAggregationRequestsRequest, options: SdkCallOptions): Promise; /** * Returns the details of one or more remediation configurations. */ describeRemediationConfigurations(input: AWS.ConfigService.DescribeRemediationConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response. Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources. */ describeRemediationExceptions(input: AWS.ConfigService.DescribeRemediationExceptionsRequest, options: SdkCallOptions): Promise; /** * Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response. */ describeRemediationExecutionStatus(input: AWS.ConfigService.DescribeRemediationExecutionStatusRequest, options: SdkCallOptions): Promise; /** * Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account. Currently, Config supports only one retention configuration per region in your account. */ describeRetentionConfigurations(input: AWS.ConfigService.DescribeRetentionConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page. */ getAggregateComplianceDetailsByConfigRule(input: AWS.ConfigService.GetAggregateComplianceDetailsByConfigRuleRequest, options: SdkCallOptions): Promise; /** * Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. */ getAggregateConfigRuleComplianceSummary(input: AWS.ConfigService.GetAggregateConfigRuleComplianceSummaryRequest, options: SdkCallOptions): Promise; /** * Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page. */ getAggregateConformancePackComplianceSummary(input: AWS.ConfigService.GetAggregateConformancePackComplianceSummaryRequest, options: SdkCallOptions): Promise; /** * Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey. For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator. */ getAggregateDiscoveredResourceCounts(input: AWS.ConfigService.GetAggregateDiscoveredResourceCountsRequest, options: SdkCallOptions): Promise; /** * Returns configuration item that is aggregated for your specific resource in a specific source account and region. */ getAggregateResourceConfig(input: AWS.ConfigService.GetAggregateResourceConfigRequest, options: SdkCallOptions): Promise; /** * Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. */ getComplianceDetailsByConfigRule(input: AWS.ConfigService.GetComplianceDetailsByConfigRuleRequest, options: SdkCallOptions): Promise; /** * Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. */ getComplianceDetailsByResource(input: AWS.ConfigService.GetComplianceDetailsByResourceRequest, options: SdkCallOptions): Promise; /** * Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. */ getComplianceSummaryByResourceType(input: AWS.ConfigService.GetComplianceSummaryByResourceTypeRequest, options: SdkCallOptions): Promise; /** * Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack. */ getConformancePackComplianceDetails(input: AWS.ConfigService.GetConformancePackComplianceDetailsRequest, options: SdkCallOptions): Promise; /** * Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack. */ getConformancePackComplianceSummary(input: AWS.ConfigService.GetConformancePackComplianceSummaryRequest, options: SdkCallOptions): Promise; /** * Returns the policy definition containing the logic for your Config Custom Policy rule. */ getCustomRulePolicy(input: AWS.ConfigService.GetCustomRulePolicyRequest, options: SdkCallOptions): Promise; /** * Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account. Example Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types. Config returns the following: The resource types (EC2 instances, IAM users, and S3 buckets). The number of each resource type (25, 20, and 15). The total number of all resources (60). The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations: You are a new Config customer. You just enabled resource recording. It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action. */ getDiscoveredResourceCounts(input: AWS.ConfigService.GetDiscoveredResourceCountsRequest, options: SdkCallOptions): Promise; /** * Returns detailed status for each member account within an organization for a given organization Config rule. */ getOrganizationConfigRuleDetailedStatus(input: AWS.ConfigService.GetOrganizationConfigRuleDetailedStatusRequest, options: SdkCallOptions): Promise; /** * Returns detailed status for each member account within an organization for a given organization conformance pack. */ getOrganizationConformancePackDetailedStatus(input: AWS.ConfigService.GetOrganizationConformancePackDetailedStatusRequest, options: SdkCallOptions): Promise; /** * Returns the policy definition containing the logic for your organization Config Custom Policy rule. */ getOrganizationCustomRulePolicy(input: AWS.ConfigService.GetOrganizationCustomRulePolicyRequest, options: SdkCallOptions): Promise; /** * Returns a list of ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems for the specified retention period. The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken. */ getResourceConfigHistory(input: AWS.ConfigService.GetResourceConfigHistoryRequest, options: SdkCallOptions): Promise; /** * Returns the details of a specific stored query. */ getStoredQuery(input: AWS.ConfigService.GetStoredQueryRequest, options: SdkCallOptions): Promise; /** * Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region. For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1. */ listAggregateDiscoveredResources(input: AWS.ConfigService.ListAggregateDiscoveredResourcesRequest, options: SdkCallOptions): Promise; /** * Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs, and can be used to identify, investigate, and understand the level of compliance in your conformance packs. Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA. */ listConformancePackComplianceScores(input: AWS.ConfigService.ListConformancePackComplianceScoresRequest, options: SdkCallOptions): Promise; /** * Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. You can specify either resource IDs or a resource name, but not both, in the same request. The response is paginated. By default, Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. */ listDiscoveredResources(input: AWS.ConfigService.ListDiscoveredResourcesRequest, options: SdkCallOptions): Promise; /** * Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100. */ listStoredQueries(input: AWS.ConfigService.ListStoredQueriesRequest, options: SdkCallOptions): Promise; /** * List the tags for Config resource. */ listTagsForResource(input: AWS.ConfigService.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Authorizes the aggregator account and region to collect data from the source account and region. */ putAggregationAuthorization(input: AWS.ConfigService.PutAggregationAuthorizationRequest, options: SdkCallOptions): Promise; /** * Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide. There are two types of rules: Config Custom Rules and Config Managed Rules. You can use PutConfigRule to create both Config custom rules and Config managed rules. Custom rules are rules that you can create using either Guard or Lambda functions. Guard (Guard GitHub Repository) is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to evaluate a custom rule. If you are adding a new Custom Lambda rule, you first need to create an Lambda function that the rule invokes to evaluate your resources. When you use PutConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN in the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object. Managed rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the SourceIdentifier key. For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by Config for new rules. If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request. For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide. */ putConfigRule(input: AWS.ConfigService.PutConfigRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization. accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones. Config should be enabled in source accounts and regions you want to aggregate. If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator. To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide. */ putConfigurationAggregator(input: AWS.ConfigService.PutConfigurationAggregatorRequest, options: SdkCallOptions): Promise; /** * Creates a new configuration recorder to record the selected resource configurations. You can use this action to change the role roleARN or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. Currently, you can specify only one configuration recorder per region in your account. If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types. */ putConfigurationRecorder(input: AWS.ConfigService.PutConfigurationRecorderRequest, options: SdkCallOptions): Promise<{}>; /** * Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across Amazon Web Services Organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide. This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. The service-linked role is created only when the role does not exist in your account. You must specify one and only one of theTemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails parameters. */ putConformancePack(input: AWS.ConfigService.PutConformancePackRequest, options: SdkCallOptions): Promise; /** * Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic. Before you can create a delivery channel, you must create a configuration recorder. You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. You can have only one delivery channel per region in your account. */ putDeliveryChannel(input: AWS.ConfigService.PutDeliveryChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule. */ putEvaluations(input: AWS.ConfigService.PutEvaluationsRequest, options: SdkCallOptions): Promise; /** * Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided. */ putExternalEvaluation(input: AWS.ConfigService.PutExternalEvaluationRequest, options: SdkCallOptions): Promise; /** * Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide. Only a master account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators. This API enables organization service access through the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with GetRole action. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com. There are two types of rules: Config Custom Rules and Config Managed Rules. You can use PutOrganizationConfigRule to create both Config custom rules and Config managed rules. Custom rules are rules that you can create using either Guard or Lambda functions. Guard (Guard GitHub Repository) is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to evaluate a custom rule. If you are adding a new Custom Lambda rule, you first need to create an Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use PutOrganizationConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. Managed rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the RuleIdentifier key. Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. Make sure to specify one of either OrganizationCustomPolicyRuleMetadata for Custom Policy rules, OrganizationCustomRuleMetadata for Custom Lambda rules, or OrganizationManagedRuleMetadata for managed rules. */ putOrganizationConfigRule(input: AWS.ConfigService.PutOrganizationConfigRuleRequest, options: SdkCallOptions): Promise; /** * Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide. Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators. This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com. Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter. Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state. */ putOrganizationConformancePack(input: AWS.ConfigService.PutOrganizationConformancePackRequest, options: SdkCallOptions): Promise; /** * Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run. This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub. For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter. However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources. */ putRemediationConfigurations(input: AWS.ConfigService.PutRemediationConfigurationsRequest, options: SdkCallOptions): Promise; /** * A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific Config rule. Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared. */ putRemediationExceptions(input: AWS.ConfigService.PutRemediationExceptionsRequest, options: SdkCallOptions): Promise; /** * Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs. The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation. When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource. Write-only schema properites are not recorded as part of the published configuration item. */ putResourceConfig(input: AWS.ConfigService.PutResourceConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object. Currently, Config supports only one retention configuration per region in your account. */ putRetentionConfiguration(input: AWS.ConfigService.PutRetentionConfigurationRequest, options: SdkCallOptions): Promise; /** * Saves a new query or updates an existing saved query. The QueryName must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region. */ putStoredQuery(input: AWS.ConfigService.PutStoredQueryRequest, options: SdkCallOptions): Promise; /** * Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the Config Developer Guide. If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500. If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = 'AWS::IAM::Role') and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25. */ selectAggregateResourceConfig(input: AWS.ConfigService.SelectAggregateResourceConfigRequest, options: SdkCallOptions): Promise; /** * Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the Config Developer Guide. */ selectResourceConfig(input: AWS.ConfigService.SelectResourceConfigRequest, options: SdkCallOptions): Promise; /** * Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources. You can specify up to 25 Config rules per request. An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts. You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically. The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example: You have a custom rule that evaluates your IAM resources every 24 hours. You update your Lambda function to add additional conditions to your rule. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API. Config invokes your Lambda function and evaluates your IAM resources. Your custom rule will still run periodic evaluations every 24 hours. */ startConfigRulesEvaluation(input: AWS.ConfigService.StartConfigRulesEvaluationRequest, options: SdkCallOptions): Promise; /** * Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account. You must have created at least one delivery channel to successfully start the configuration recorder. */ startConfigurationRecorder(input: AWS.ConfigService.StartConfigurationRecorderRequest, options: SdkCallOptions): Promise<{}>; /** * Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous. You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again. */ startRemediationExecution(input: AWS.ConfigService.StartRemediationExecutionRequest, options: SdkCallOptions): Promise; /** * Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account. */ stopConfigurationRecorder(input: AWS.ConfigService.StopConfigurationRecorderRequest, options: SdkCallOptions): Promise<{}>; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. */ tagResource(input: AWS.ConfigService.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes specified tags from a resource. */ untagResource(input: AWS.ConfigService.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; } export interface Connect { /** * This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance. */ associateApprovedOrigin(input: AWS.Connect.AssociateApprovedOriginRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot. */ associateBot(input: AWS.Connect.AssociateBotRequest, options: SdkCallOptions): Promise<{}>; /** * Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language. */ associateDefaultVocabulary(input: AWS.Connect.AssociateDefaultVocabularyRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association. */ associateInstanceStorageConfig(input: AWS.Connect.AssociateInstanceStorageConfigRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function. */ associateLambdaFunction(input: AWS.Connect.AssociateLambdaFunctionRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex bot. */ associateLexBot(input: AWS.Connect.AssociateLexBotRequest, options: SdkCallOptions): Promise<{}>; /** * Associates a flow with a phone number claimed to your Amazon Connect instance. */ associatePhoneNumberContactFlow(input: AWS.Connect.AssociatePhoneNumberContactFlowRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick connects with a queue. */ associateQueueQuickConnects(input: AWS.Connect.AssociateQueueQuickConnectsRequest, options: SdkCallOptions): Promise<{}>; /** * Associates a set of queues with a routing profile. */ associateRoutingProfileQueues(input: AWS.Connect.AssociateRoutingProfileQueuesRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance. */ associateSecurityKey(input: AWS.Connect.AssociateSecurityKeyRequest, options: SdkCallOptions): Promise; /** * Claims an available phone number to your Amazon Connect instance. */ claimPhoneNumber(input: AWS.Connect.ClaimPhoneNumberRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the specified Amazon Connect instance. */ createAgentStatus(input: AWS.Connect.CreateAgentStatusRequest, options: SdkCallOptions): Promise; /** * Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. */ createContactFlow(input: AWS.Connect.CreateContactFlowRequest, options: SdkCallOptions): Promise; /** * Creates a flow module for the specified Amazon Connect instance. */ createContactFlowModule(input: AWS.Connect.CreateContactFlowModuleRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Creates hours of operation. */ createHoursOfOperation(input: AWS.Connect.CreateHoursOfOperationRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. */ createInstance(input: AWS.Connect.CreateInstanceRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Web Services resource association with an Amazon Connect instance. */ createIntegrationAssociation(input: AWS.Connect.CreateIntegrationAssociationRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance. */ createQueue(input: AWS.Connect.CreateQueueRequest, options: SdkCallOptions): Promise; /** * Creates a quick connect for the specified Amazon Connect instance. */ createQuickConnect(input: AWS.Connect.CreateQuickConnectRequest, options: SdkCallOptions): Promise; /** * Creates a new routing profile. */ createRoutingProfile(input: AWS.Connect.CreateRoutingProfileRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Creates a security profile. */ createSecurityProfile(input: AWS.Connect.CreateSecurityProfileRequest, options: SdkCallOptions): Promise; /** * Creates a new task template in the specified Amazon Connect instance. */ createTaskTemplate(input: AWS.Connect.CreateTaskTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a use case for an integration association. */ createUseCase(input: AWS.Connect.CreateUseCaseRequest, options: SdkCallOptions): Promise; /** * Creates a user account for the specified Amazon Connect instance. For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide. */ createUser(input: AWS.Connect.CreateUserRequest, options: SdkCallOptions): Promise; /** * Creates a new user hierarchy group. */ createUserHierarchyGroup(input: AWS.Connect.CreateUserHierarchyGroupRequest, options: SdkCallOptions): Promise; /** * Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language. */ createVocabulary(input: AWS.Connect.CreateVocabularyRequest, options: SdkCallOptions): Promise; /** * Deletes a flow for the specified Amazon Connect instance. */ deleteContactFlow(input: AWS.Connect.DeleteContactFlowRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified flow module. */ deleteContactFlowModule(input: AWS.Connect.DeleteContactFlowModuleRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Deletes an hours of operation. */ deleteHoursOfOperation(input: AWS.Connect.DeleteHoursOfOperationRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. */ deleteInstance(input: AWS.Connect.DeleteInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it. */ deleteIntegrationAssociation(input: AWS.Connect.DeleteIntegrationAssociationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a quick connect. */ deleteQuickConnect(input: AWS.Connect.DeleteQuickConnectRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Deletes a security profile. */ deleteSecurityProfile(input: AWS.Connect.DeleteSecurityProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the task template. */ deleteTaskTemplate(input: AWS.Connect.DeleteTaskTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a use case from an integration association. */ deleteUseCase(input: AWS.Connect.DeleteUseCaseRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide. */ deleteUser(input: AWS.Connect.DeleteUserRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups. */ deleteUserHierarchyGroup(input: AWS.Connect.DeleteUserHierarchyGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the vocabulary that has the given identifier. */ deleteVocabulary(input: AWS.Connect.DeleteVocabularyRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Describes an agent status. */ describeAgentStatus(input: AWS.Connect.DescribeAgentStatusRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Contact information remains available in Amazon Connect for 24 months, and then it is deleted. Only data from November 12, 2021, and later is returned by this API. */ describeContact(input: AWS.Connect.DescribeContactRequest, options: SdkCallOptions): Promise; /** * Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. */ describeContactFlow(input: AWS.Connect.DescribeContactFlowRequest, options: SdkCallOptions): Promise; /** * Describes the specified flow module. */ describeContactFlowModule(input: AWS.Connect.DescribeContactFlowModuleRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Describes the hours of operation. */ describeHoursOfOperation(input: AWS.Connect.DescribeHoursOfOperationRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked. */ describeInstance(input: AWS.Connect.DescribeInstanceRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute. */ describeInstanceAttribute(input: AWS.Connect.DescribeInstanceAttributeRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID. */ describeInstanceStorageConfig(input: AWS.Connect.DescribeInstanceStorageConfigRequest, options: SdkCallOptions): Promise; /** * Gets details and status of a phone number that’s claimed to your Amazon Connect instance */ describePhoneNumber(input: AWS.Connect.DescribePhoneNumberRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue. */ describeQueue(input: AWS.Connect.DescribeQueueRequest, options: SdkCallOptions): Promise; /** * Describes the quick connect. */ describeQuickConnect(input: AWS.Connect.DescribeQuickConnectRequest, options: SdkCallOptions): Promise; /** * Describes the specified routing profile. */ describeRoutingProfile(input: AWS.Connect.DescribeRoutingProfileRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Gets basic information about the security profle. */ describeSecurityProfile(input: AWS.Connect.DescribeSecurityProfileRequest, options: SdkCallOptions): Promise; /** * Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output. */ describeUser(input: AWS.Connect.DescribeUserRequest, options: SdkCallOptions): Promise; /** * Describes the specified hierarchy group. */ describeUserHierarchyGroup(input: AWS.Connect.DescribeUserHierarchyGroupRequest, options: SdkCallOptions): Promise; /** * Describes the hierarchy structure of the specified Amazon Connect instance. */ describeUserHierarchyStructure(input: AWS.Connect.DescribeUserHierarchyStructureRequest, options: SdkCallOptions): Promise; /** * Describes the specified vocabulary. */ describeVocabulary(input: AWS.Connect.DescribeVocabularyRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect. */ disassociateApprovedOrigin(input: AWS.Connect.DisassociateApprovedOriginRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. */ disassociateBot(input: AWS.Connect.DisassociateBotRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Removes the storage type configurations for the specified resource type and association ID. */ disassociateInstanceStorageConfig(input: AWS.Connect.DisassociateInstanceStorageConfigRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks. */ disassociateLambdaFunction(input: AWS.Connect.DisassociateLambdaFunctionRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot. */ disassociateLexBot(input: AWS.Connect.DisassociateLexBotRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the flow association from a phone number claimed to your Amazon Connect instance, if a flow association exists. */ disassociatePhoneNumberContactFlow(input: AWS.Connect.DisassociatePhoneNumberContactFlowRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Disassociates a set of quick connects from a queue. */ disassociateQueueQuickConnects(input: AWS.Connect.DisassociateQueueQuickConnectsRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates a set of queues from a routing profile. */ disassociateRoutingProfileQueues(input: AWS.Connect.DisassociateRoutingProfileQueuesRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key. */ disassociateSecurityKey(input: AWS.Connect.DisassociateSecurityKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves the contact attributes for the specified contact. */ getContactAttributes(input: AWS.Connect.GetContactAttributesRequest, options: SdkCallOptions): Promise; /** * Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide. */ getCurrentMetricData(input: AWS.Connect.GetCurrentMetricDataRequest, options: SdkCallOptions): Promise; /** * Gets the real-time active user data from the specified Amazon Connect instance. */ getCurrentUserData(input: AWS.Connect.GetCurrentUserDataRequest, options: SdkCallOptions): Promise; /** * Retrieves a token for federation. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect */ getFederationToken(input: AWS.Connect.GetFederationTokenRequest, options: SdkCallOptions): Promise; /** * Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide. */ getMetricData(input: AWS.Connect.GetMetricDataRequest, options: SdkCallOptions): Promise; /** * Gets details about a specific task template in the specified Amazon Connect instance. */ getTaskTemplate(input: AWS.Connect.GetTaskTemplateRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Lists agent statuses. */ listAgentStatuses(input: AWS.Connect.ListAgentStatusRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance. */ listApprovedOrigins(input: AWS.Connect.ListApprovedOriginsRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots. */ listBots(input: AWS.Connect.ListBotsRequest, options: SdkCallOptions): Promise; /** * Provides information about the flow modules for the specified Amazon Connect instance. */ listContactFlowModules(input: AWS.Connect.ListContactFlowModulesRequest, options: SdkCallOptions): Promise; /** * Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. For more information about flows, see Flows in the Amazon Connect Administrator Guide. */ listContactFlows(input: AWS.Connect.ListContactFlowsRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. */ listContactReferences(input: AWS.Connect.ListContactReferencesRequest, options: SdkCallOptions): Promise; /** * Lists the default vocabularies for the specified Amazon Connect instance. */ listDefaultVocabularies(input: AWS.Connect.ListDefaultVocabulariesRequest, options: SdkCallOptions): Promise; /** * Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide. */ listHoursOfOperations(input: AWS.Connect.ListHoursOfOperationsRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance. */ listInstanceAttributes(input: AWS.Connect.ListInstanceAttributesRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type. */ listInstanceStorageConfigs(input: AWS.Connect.ListInstanceStorageConfigsRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked. */ listInstances(input: AWS.Connect.ListInstancesRequest, options: SdkCallOptions): Promise; /** * Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance. */ listIntegrationAssociations(input: AWS.Connect.ListIntegrationAssociationsRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks. */ listLambdaFunctions(input: AWS.Connect.ListLambdaFunctionsRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API. */ listLexBots(input: AWS.Connect.ListLexBotsRequest, options: SdkCallOptions): Promise; /** * Provides information about the phone numbers for the specified Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide. */ listPhoneNumbers(input: AWS.Connect.ListPhoneNumbersRequest, options: SdkCallOptions): Promise; /** * Lists phone numbers claimed to your Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide. */ listPhoneNumbersV2(input: AWS.Connect.ListPhoneNumbersV2Request, options: SdkCallOptions): Promise; /** * Provides information about the prompts for the specified Amazon Connect instance. */ listPrompts(input: AWS.Connect.ListPromptsRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Lists the quick connects associated with a queue. */ listQueueQuickConnects(input: AWS.Connect.ListQueueQuickConnectsRequest, options: SdkCallOptions): Promise; /** * Provides information about the queues for the specified Amazon Connect instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide. */ listQueues(input: AWS.Connect.ListQueuesRequest, options: SdkCallOptions): Promise; /** * Provides information about the quick connects for the specified Amazon Connect instance. */ listQuickConnects(input: AWS.Connect.ListQuickConnectsRequest, options: SdkCallOptions): Promise; /** * Lists the queues associated with a routing profile. */ listRoutingProfileQueues(input: AWS.Connect.ListRoutingProfileQueuesRequest, options: SdkCallOptions): Promise; /** * Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide. */ listRoutingProfiles(input: AWS.Connect.ListRoutingProfilesRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all security keys associated with the instance. */ listSecurityKeys(input: AWS.Connect.ListSecurityKeysRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Lists the permissions granted to a security profile. */ listSecurityProfilePermissions(input: AWS.Connect.ListSecurityProfilePermissionsRequest, options: SdkCallOptions): Promise; /** * Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. */ listSecurityProfiles(input: AWS.Connect.ListSecurityProfilesRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide. */ listTagsForResource(input: AWS.Connect.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists task templates for the specified Amazon Connect instance. */ listTaskTemplates(input: AWS.Connect.ListTaskTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists the use cases for the integration association. */ listUseCases(input: AWS.Connect.ListUseCasesRequest, options: SdkCallOptions): Promise; /** * Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide. */ listUserHierarchyGroups(input: AWS.Connect.ListUserHierarchyGroupsRequest, options: SdkCallOptions): Promise; /** * Provides summary information about the users for the specified Amazon Connect instance. */ listUsers(input: AWS.Connect.ListUsersRequest, options: SdkCallOptions): Promise; /** * Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status. For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide. */ putUserStatus(input: AWS.Connect.PutUserStatusRequest, options: SdkCallOptions): Promise; /** * Releases a phone number previously claimed to an Amazon Connect instance. */ releasePhoneNumber(input: AWS.Connect.ReleasePhoneNumberRequest, options: SdkCallOptions): Promise<{}>; /** * When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call. Only voice recordings are supported at this time. */ resumeContactRecording(input: AWS.Connect.ResumeContactRecordingRequest, options: SdkCallOptions): Promise; /** * Searches for available phone numbers that you can claim to your Amazon Connect instance. */ searchAvailablePhoneNumbers(input: AWS.Connect.SearchAvailablePhoneNumbersRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Searches queues in an Amazon Connect instance, with optional filtering. */ searchQueues(input: AWS.Connect.SearchQueuesRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Searches routing profiles in an Amazon Connect instance, with optional filtering. */ searchRoutingProfiles(input: AWS.Connect.SearchRoutingProfilesRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Searches security profiles in an Amazon Connect instance, with optional filtering. */ searchSecurityProfiles(input: AWS.Connect.SearchSecurityProfilesRequest, options: SdkCallOptions): Promise; /** * Searches users in an Amazon Connect instance, with optional filtering. */ searchUsers(input: AWS.Connect.SearchUsersRequest, options: SdkCallOptions): Promise; /** * Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode. */ searchVocabularies(input: AWS.Connect.SearchVocabulariesRequest, options: SdkCallOptions): Promise; /** * Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see Chat in the Amazon Connect Administrator Guide. */ startChatContact(input: AWS.Connect.StartChatContactRequest, options: SdkCallOptions): Promise; /** * Starts recording the contact: If the API is called before the agent joins the call, recording starts when the agent joins the call. If the API is called after the agent joins the call, recording starts at the time of the API call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior block. Only voice recordings are supported at this time. */ startContactRecording(input: AWS.Connect.StartContactRecordingRequest, options: SdkCallOptions): Promise; /** * Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide. */ startContactStreaming(input: AWS.Connect.StartContactStreamingRequest, options: SdkCallOptions): Promise; /** * Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId). Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide. Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns. */ startOutboundVoiceContact(input: AWS.Connect.StartOutboundVoiceContactRequest, options: SdkCallOptions): Promise; /** * Initiates a flow to start a new task. */ startTaskContact(input: AWS.Connect.StartTaskContactRequest, options: SdkCallOptions): Promise; /** * Ends the specified contact. This call does not work for the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER */ stopContact(input: AWS.Connect.StopContactRequest, options: SdkCallOptions): Promise; /** * Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only voice recordings are supported at this time. */ stopContactRecording(input: AWS.Connect.StopContactRecordingRequest, options: SdkCallOptions): Promise; /** * Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API. */ stopContactStreaming(input: AWS.Connect.StopContactStreamingRequest, options: SdkCallOptions): Promise; /** * When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording. The period of time that the recording is suspended is filled with silence in the final recording. Only voice recordings are supported at this time. */ suspendContactRecording(input: AWS.Connect.SuspendContactRecordingRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide. */ tagResource(input: AWS.Connect.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers. Note the following requirements: Transfer is supported for only TASK contacts. Do not use both QueueId and UserId in the same call. The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. The TransferContact API can be called only on active contacts. A contact cannot be transferred more than 11 times. */ transferContact(input: AWS.Connect.TransferContactRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified resource. */ untagResource(input: AWS.Connect.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Updates agent status. */ updateAgentStatus(input: AWS.Connect.UpdateAgentStatusRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request. You can add or update user-defined contact information for both ongoing and completed contacts. */ updateContact(input: AWS.Connect.UpdateContactRequest, options: SdkCallOptions): Promise; /** * Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide. */ updateContactAttributes(input: AWS.Connect.UpdateContactAttributesRequest, options: SdkCallOptions): Promise; /** * Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language. */ updateContactFlowContent(input: AWS.Connect.UpdateContactFlowContentRequest, options: SdkCallOptions): Promise<{}>; /** * Updates metadata about specified flow. */ updateContactFlowMetadata(input: AWS.Connect.UpdateContactFlowMetadataRequest, options: SdkCallOptions): Promise<{}>; /** * Updates specified flow module for the specified Amazon Connect instance. */ updateContactFlowModuleContent(input: AWS.Connect.UpdateContactFlowModuleContentRequest, options: SdkCallOptions): Promise; /** * Updates metadata about specified flow module. */ updateContactFlowModuleMetadata(input: AWS.Connect.UpdateContactFlowModuleMetadataRequest, options: SdkCallOptions): Promise; /** * The name of the flow. You can also create and update flows using the Amazon Connect Flow language. */ updateContactFlowName(input: AWS.Connect.UpdateContactFlowNameRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the scheduled time of a task contact that is already scheduled. */ updateContactSchedule(input: AWS.Connect.UpdateContactScheduleRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation. */ updateHoursOfOperation(input: AWS.Connect.UpdateHoursOfOperationRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type. */ updateInstanceAttribute(input: AWS.Connect.UpdateInstanceAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Updates an existing configuration for a resource type. This API is idempotent. */ updateInstanceStorageConfig(input: AWS.Connect.UpdateInstanceStorageConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region. */ updatePhoneNumber(input: AWS.Connect.UpdatePhoneNumberRequest, options: SdkCallOptions): Promise; /** * This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation for the specified queue. */ updateQueueHoursOfOperation(input: AWS.Connect.UpdateQueueHoursOfOperationRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Updates the maximum number of contacts allowed in a queue before it is considered full. */ updateQueueMaxContacts(input: AWS.Connect.UpdateQueueMaxContactsRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Updates the name and description of a queue. At least Name or Description must be provided. */ updateQueueName(input: AWS.Connect.UpdateQueueNameRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. */ updateQueueOutboundCallerConfig(input: AWS.Connect.UpdateQueueOutboundCallerConfigRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Updates the status of the queue. */ updateQueueStatus(input: AWS.Connect.UpdateQueueStatusRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the configuration settings for the specified quick connect. */ updateQuickConnectConfig(input: AWS.Connect.UpdateQuickConnectConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided. */ updateQuickConnectName(input: AWS.Connect.UpdateQuickConnectNameRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile. */ updateRoutingProfileConcurrency(input: AWS.Connect.UpdateRoutingProfileConcurrencyRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the default outbound queue of a routing profile. */ updateRoutingProfileDefaultOutboundQueue(input: AWS.Connect.UpdateRoutingProfileDefaultOutboundQueueRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided. */ updateRoutingProfileName(input: AWS.Connect.UpdateRoutingProfileNameRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the properties associated with a set of queues for a routing profile. */ updateRoutingProfileQueues(input: AWS.Connect.UpdateRoutingProfileQueuesRequest, options: SdkCallOptions): Promise<{}>; /** * This API is in preview release for Amazon Connect and is subject to change. Updates a security profile. */ updateSecurityProfile(input: AWS.Connect.UpdateSecurityProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content. */ updateTaskTemplate(input: AWS.Connect.UpdateTaskTemplateRequest, options: SdkCallOptions): Promise; /** * Assigns the specified hierarchy group to the specified user. */ updateUserHierarchy(input: AWS.Connect.UpdateUserHierarchyRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the name of the user hierarchy group. */ updateUserHierarchyGroupName(input: AWS.Connect.UpdateUserHierarchyGroupNameRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the user hierarchy structure: add, remove, and rename user hierarchy levels. */ updateUserHierarchyStructure(input: AWS.Connect.UpdateUserHierarchyStructureRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the identity information for the specified user. We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide. */ updateUserIdentityInfo(input: AWS.Connect.UpdateUserIdentityInfoRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the phone configuration settings for the specified user. */ updateUserPhoneConfig(input: AWS.Connect.UpdateUserPhoneConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Assigns the specified routing profile to the specified user. */ updateUserRoutingProfile(input: AWS.Connect.UpdateUserRoutingProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Assigns the specified security profiles to the specified user. */ updateUserSecurityProfiles(input: AWS.Connect.UpdateUserSecurityProfilesRequest, options: SdkCallOptions): Promise<{}>; } export interface ConnectCampaigns { /** * Creates a campaign for the specified Amazon Connect account. This API is idempotent. */ createCampaign(input: AWS.ConnectCampaigns.CreateCampaignRequest, options: SdkCallOptions): Promise; /** * Deletes a campaign from the specified Amazon Connect account. */ deleteCampaign(input: AWS.ConnectCampaigns.DeleteCampaignRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a connect instance config from the specified AWS account. */ deleteConnectInstanceConfig(input: AWS.ConnectCampaigns.DeleteConnectInstanceConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance. */ deleteInstanceOnboardingJob(input: AWS.ConnectCampaigns.DeleteInstanceOnboardingJobRequest, options: SdkCallOptions): Promise<{}>; /** * Describes the specific campaign. */ describeCampaign(input: AWS.ConnectCampaigns.DescribeCampaignRequest, options: SdkCallOptions): Promise; /** * Get state of a campaign for the specified Amazon Connect account. */ getCampaignState(input: AWS.ConnectCampaigns.GetCampaignStateRequest, options: SdkCallOptions): Promise; /** * Get state of campaigns for the specified Amazon Connect account. */ getCampaignStateBatch(input: AWS.ConnectCampaigns.GetCampaignStateBatchRequest, options: SdkCallOptions): Promise; /** * Get the specific Connect instance config. */ getConnectInstanceConfig(input: AWS.ConnectCampaigns.GetConnectInstanceConfigRequest, options: SdkCallOptions): Promise; /** * Get the specific instance onboarding job status. */ getInstanceOnboardingJobStatus(input: AWS.ConnectCampaigns.GetInstanceOnboardingJobStatusRequest, options: SdkCallOptions): Promise; /** * Provides summary information about the campaigns under the specified Amazon Connect account. */ listCampaigns(input: AWS.ConnectCampaigns.ListCampaignsRequest, options: SdkCallOptions): Promise; /** * List tags for a resource. */ listTagsForResource(input: AWS.ConnectCampaigns.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Pauses a campaign for the specified Amazon Connect account. */ pauseCampaign(input: AWS.ConnectCampaigns.PauseCampaignRequest, options: SdkCallOptions): Promise<{}>; /** * Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent. */ putDialRequestBatch(input: AWS.ConnectCampaigns.PutDialRequestBatchRequest, options: SdkCallOptions): Promise; /** * Stops a campaign for the specified Amazon Connect account. */ resumeCampaign(input: AWS.ConnectCampaigns.ResumeCampaignRequest, options: SdkCallOptions): Promise<{}>; /** * Starts a campaign for the specified Amazon Connect account. */ startCampaign(input: AWS.ConnectCampaigns.StartCampaignRequest, options: SdkCallOptions): Promise<{}>; /** * Onboard the specific Amazon Connect instance to Connect Campaigns. */ startInstanceOnboardingJob(input: AWS.ConnectCampaigns.StartInstanceOnboardingJobRequest, options: SdkCallOptions): Promise; /** * Stops a campaign for the specified Amazon Connect account. */ stopCampaign(input: AWS.ConnectCampaigns.StopCampaignRequest, options: SdkCallOptions): Promise<{}>; /** * Tag a resource. */ tagResource(input: AWS.ConnectCampaigns.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Untag a resource. */ untagResource(input: AWS.ConnectCampaigns.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the dialer config of a campaign. This API is idempotent. */ updateCampaignDialerConfig(input: AWS.ConnectCampaigns.UpdateCampaignDialerConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the name of a campaign. This API is idempotent. */ updateCampaignName(input: AWS.ConnectCampaigns.UpdateCampaignNameRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the outbound call config of a campaign. This API is idempotent. */ updateCampaignOutboundCallConfig(input: AWS.ConnectCampaigns.UpdateCampaignOutboundCallConfigRequest, options: SdkCallOptions): Promise<{}>; } export interface ConnectCases { /** * Returns the description for the list of fields in the request parameters. */ batchGetField(input: AWS.ConnectCases.BatchGetFieldRequest, options: SdkCallOptions): Promise; /** * Creates and updates a set of field options for a single select field in a Cases domain. */ batchPutFieldOptions(input: AWS.ConnectCases.BatchPutFieldOptionsRequest, options: SdkCallOptions): Promise; /** * Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types. customer_id is a required field when creating a case. */ createCase(input: AWS.ConnectCases.CreateCaseRequest, options: SdkCallOptions): Promise; /** * Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain. This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. */ createDomain(input: AWS.ConnectCases.CreateDomainRequest, options: SdkCallOptions): Promise; /** * Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain. */ createField(input: AWS.ConnectCases.CreateFieldRequest, options: SdkCallOptions): Promise; /** * Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface: Fields to display to the users Field ordering Title and Status fields cannot be part of layouts since they are not configurable. */ createLayout(input: AWS.ConnectCases.CreateLayoutRequest, options: SdkCallOptions): Promise; /** * Creates a related item (comments, tasks, and contacts) and associates it with a case. A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts. */ createRelatedItem(input: AWS.ConnectCases.CreateRelatedItemRequest, options: SdkCallOptions): Promise; /** * Creates a template in the Cases domain. This template is used to define the case object model (that is, define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. */ createTemplate(input: AWS.ConnectCases.CreateTemplateRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific case if it exists. */ getCase(input: AWS.ConnectCases.GetCaseRequest, options: SdkCallOptions): Promise; /** * Returns the case event publishing configuration. */ getCaseEventConfiguration(input: AWS.ConnectCases.GetCaseEventConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific domain if it exists. */ getDomain(input: AWS.ConnectCases.GetDomainRequest, options: SdkCallOptions): Promise; /** * Returns the details for the requested layout. */ getLayout(input: AWS.ConnectCases.GetLayoutRequest, options: SdkCallOptions): Promise; /** * Returns the details for the requested template. */ getTemplate(input: AWS.ConnectCases.GetTemplateRequest, options: SdkCallOptions): Promise; /** * Lists cases for a given contact. */ listCasesForContact(input: AWS.ConnectCases.ListCasesForContactRequest, options: SdkCallOptions): Promise; /** * Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain. */ listDomains(input: AWS.ConnectCases.ListDomainsRequest, options: SdkCallOptions): Promise; /** * Lists all of the field options for a field identifier in the domain. */ listFieldOptions(input: AWS.ConnectCases.ListFieldOptionsRequest, options: SdkCallOptions): Promise; /** * Lists all fields in a Cases domain. */ listFields(input: AWS.ConnectCases.ListFieldsRequest, options: SdkCallOptions): Promise; /** * Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout. */ listLayouts(input: AWS.ConnectCases.ListLayoutsRequest, options: SdkCallOptions): Promise; /** * Lists tags for a resource. */ listTagsForResource(input: AWS.ConnectCases.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. */ listTemplates(input: AWS.ConnectCases.ListTemplatesRequest, options: SdkCallOptions): Promise; /** * API for adding case event publishing configuration */ putCaseEventConfiguration(input: AWS.ConnectCases.PutCaseEventConfigurationRequest, options: SdkCallOptions): Promise; /** * Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents. */ searchCases(input: AWS.ConnectCases.SearchCasesRequest, options: SdkCallOptions): Promise; /** * Searches for related items that are associated with a case. If no filters are provided, this returns all related items associated with a case. */ searchRelatedItems(input: AWS.ConnectCases.SearchRelatedItemsRequest, options: SdkCallOptions): Promise; /** * Adds tags to a resource. */ tagResource(input: AWS.ConnectCases.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Untags a resource. */ untagResource(input: AWS.ConnectCases.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input . If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. */ updateCase(input: AWS.ConnectCases.UpdateCaseRequest, options: SdkCallOptions): Promise; /** * Updates the properties of an existing field. */ updateField(input: AWS.ConnectCases.UpdateFieldRequest, options: SdkCallOptions): Promise; /** * Updates the attributes of an existing layout. If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. A ValidationException is returned when you add non-existent fieldIds to a layout. Title and Status fields cannot be part of layouts because they are not configurable. */ updateLayout(input: AWS.ConnectCases.UpdateLayoutRequest, options: SdkCallOptions): Promise; /** * Updates the attributes of an existing template. The template attributes that can be modified include name, description, layouts, and requiredFields. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved. */ updateTemplate(input: AWS.ConnectCases.UpdateTemplateRequest, options: SdkCallOptions): Promise; } export interface ConnectContactLens { /** * Provides a list of analysis segments for a real-time analysis session. */ listRealtimeContactAnalysisSegments(input: AWS.ConnectContactLens.ListRealtimeContactAnalysisSegmentsRequest, options: SdkCallOptions): Promise; } export interface ConnectParticipant { /** * Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. */ completeAttachmentUpload(input: AWS.ConnectParticipant.CompleteAttachmentUploadRequest, options: SdkCallOptions): Promise; /** * Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken. The participant token is valid for the lifetime of the participant – until they are part of a contact. The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic. For chat, you need to publish the following on the established websocket connection: {"topic":"aws/subscribe","content":{"topics":["aws/chat"]}} Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before. Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide. Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. */ createParticipantConnection(input: AWS.ConnectParticipant.CreateParticipantConnectionRequest, options: SdkCallOptions): Promise; /** * Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. */ disconnectParticipant(input: AWS.ConnectParticipant.DisconnectParticipantRequest, options: SdkCallOptions): Promise; /** * Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. */ getAttachment(input: AWS.ConnectParticipant.GetAttachmentRequest, options: SdkCallOptions): Promise; /** * Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. */ getTranscript(input: AWS.ConnectParticipant.GetTranscriptRequest, options: SdkCallOptions): Promise; /** * Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. */ sendEvent(input: AWS.ConnectParticipant.SendEventRequest, options: SdkCallOptions): Promise; /** * Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. */ sendMessage(input: AWS.ConnectParticipant.SendMessageRequest, options: SdkCallOptions): Promise; /** * Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. */ startAttachmentUpload(input: AWS.ConnectParticipant.StartAttachmentUploadRequest, options: SdkCallOptions): Promise; } export interface ControlTower { /** * This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. */ disableControl(input: AWS.ControlTower.DisableControlInput, options: SdkCallOptions): Promise; /** * This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. */ enableControl(input: AWS.ControlTower.EnableControlInput, options: SdkCallOptions): Promise; /** * Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. */ getControlOperation(input: AWS.ControlTower.GetControlOperationInput, options: SdkCallOptions): Promise; /** * Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains. */ listEnabledControls(input: AWS.ControlTower.ListEnabledControlsInput, options: SdkCallOptions): Promise; } export interface CostExplorer { /** * Creates a new cost anomaly detection monitor with the requested type and monitor specification. */ createAnomalyMonitor(input: AWS.CostExplorer.CreateAnomalyMonitorRequest, options: SdkCallOptions): Promise; /** * Adds a subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set a dollar threshold and a time frequency for receiving notifications. */ createAnomalySubscription(input: AWS.CostExplorer.CreateAnomalySubscriptionRequest, options: SdkCallOptions): Promise; /** * Creates a new Cost Category with the requested name and rules. */ createCostCategoryDefinition(input: AWS.CostExplorer.CreateCostCategoryDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a cost anomaly monitor. */ deleteAnomalyMonitor(input: AWS.CostExplorer.DeleteAnomalyMonitorRequest, options: SdkCallOptions): Promise; /** * Deletes a cost anomaly subscription. */ deleteAnomalySubscription(input: AWS.CostExplorer.DeleteAnomalySubscriptionRequest, options: SdkCallOptions): Promise; /** * Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category. */ deleteCostCategoryDefinition(input: AWS.CostExplorer.DeleteCostCategoryDefinitionRequest, options: SdkCallOptions): Promise; /** * Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account. You have the option to use EffectiveOn to return a Cost Category that's active on a specific date. If there's no EffectiveOn specified, you see a Cost Category that's effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. */ describeCostCategoryDefinition(input: AWS.CostExplorer.DescribeCostCategoryDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object. */ getAnomalies(input: AWS.CostExplorer.GetAnomaliesRequest, options: SdkCallOptions): Promise; /** * Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). */ getAnomalyMonitors(input: AWS.CostExplorer.GetAnomalyMonitorsRequest, options: SdkCallOptions): Promise; /** * Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). */ getAnomalySubscriptions(input: AWS.CostExplorer.GetAnomalySubscriptionsRequest, options: SdkCallOptions): Promise; /** * Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts or UsageQuantity. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide. */ getCostAndUsage(input: AWS.CostExplorer.GetCostAndUsageRequest, options: SdkCallOptions): Promise; /** * Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only. This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information about how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide. */ getCostAndUsageWithResources(input: AWS.CostExplorer.GetCostAndUsageWithResourcesRequest, options: SdkCallOptions): Promise; /** * Retrieves an array of Cost Category names and values incurred cost. If some Cost Category names and values are not associated with any cost, they will not be returned by this API. */ getCostCategories(input: AWS.CostExplorer.GetCostCategoriesRequest, options: SdkCallOptions): Promise; /** * Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs. */ getCostForecast(input: AWS.CostExplorer.GetCostForecastRequest, options: SdkCallOptions): Promise; /** * Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. */ getDimensionValues(input: AWS.CostExplorer.GetDimensionValuesRequest, options: SdkCallOptions): Promise; /** * Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY To determine valid values for a dimension, use the GetDimensionValues operation. */ getReservationCoverage(input: AWS.CostExplorer.GetReservationCoverageRequest, options: SdkCallOptions): Promise; /** * Gets recommendations for reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing. Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings. For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of normalized units. This way, you can purchase any instance size that you want. For this example, your RI recommendation is for c4.large because that is the smallest size instance in the c4 instance family. */ getReservationPurchaseRecommendation(input: AWS.CostExplorer.GetReservationPurchaseRecommendationRequest, options: SdkCallOptions): Promise; /** * Retrieves the reservation utilization for your account. Management account in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID. */ getReservationUtilization(input: AWS.CostExplorer.GetReservationUtilizationRequest, options: SdkCallOptions): Promise; /** * Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances. Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide. */ getRightsizingRecommendation(input: AWS.CostExplorer.GetRightsizingRecommendationRequest, options: SdkCallOptions): Promise; /** * Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY To determine valid values for a dimension, use the GetDimensionValues operation. */ getSavingsPlansCoverage(input: AWS.CostExplorer.GetSavingsPlansCoverageRequest, options: SdkCallOptions): Promise; /** * Retrieves your request parameters, Savings Plan Recommendations Summary and Details. */ getSavingsPlansPurchaseRecommendation(input: AWS.CostExplorer.GetSavingsPlansPurchaseRecommendationRequest, options: SdkCallOptions): Promise; /** * Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. You can't group by any dimension values for GetSavingsPlansUtilization. */ getSavingsPlansUtilization(input: AWS.CostExplorer.GetSavingsPlansUtilizationRequest, options: SdkCallOptions): Promise; /** * Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn. */ getSavingsPlansUtilizationDetails(input: AWS.CostExplorer.GetSavingsPlansUtilizationDetailsRequest, options: SdkCallOptions): Promise; /** * Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. */ getTags(input: AWS.CostExplorer.GetTagsRequest, options: SdkCallOptions): Promise; /** * Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage. */ getUsageForecast(input: AWS.CostExplorer.GetUsageForecastRequest, options: SdkCallOptions): Promise; /** * Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned. */ listCostAllocationTags(input: AWS.CostExplorer.ListCostAllocationTagsRequest, options: SdkCallOptions): Promise; /** * Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100. */ listCostCategoryDefinitions(input: AWS.CostExplorer.ListCostCategoryDefinitionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN). */ listTagsForResource(input: AWS.CostExplorer.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Modifies the feedback property of a given cost anomaly. */ provideAnomalyFeedback(input: AWS.CostExplorer.ProvideAnomalyFeedbackRequest, options: SdkCallOptions): Promise; /** * An API operation for adding one or more tags (key-value pairs) to a resource. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value you specify replaces the previous value for that tag. Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use. */ tagResource(input: AWS.CostExplorer.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value. */ untagResource(input: AWS.CostExplorer.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past. */ updateAnomalyMonitor(input: AWS.CostExplorer.UpdateAnomalyMonitorRequest, options: SdkCallOptions): Promise; /** * Updates an existing cost anomaly monitor subscription. */ updateAnomalySubscription(input: AWS.CostExplorer.UpdateAnomalySubscriptionRequest, options: SdkCallOptions): Promise; /** * Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag). */ updateCostAllocationTagsStatus(input: AWS.CostExplorer.UpdateCostAllocationTagsStatusRequest, options: SdkCallOptions): Promise; /** * Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months. */ updateCostCategoryDefinition(input: AWS.CostExplorer.UpdateCostCategoryDefinitionRequest, options: SdkCallOptions): Promise; } export interface CUR { /** * Deletes the specified report. */ deleteReportDefinition(input: AWS.CUR.DeleteReportDefinitionRequest, options: SdkCallOptions): Promise; /** * Lists the AWS Cost and Usage reports available to this account. */ describeReportDefinitions(input: AWS.CUR.DescribeReportDefinitionsRequest, options: SdkCallOptions): Promise; /** * Allows you to programatically update your report preferences. */ modifyReportDefinition(input: AWS.CUR.ModifyReportDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a new report using the description that you provide. */ putReportDefinition(input: AWS.CUR.PutReportDefinitionRequest, options: SdkCallOptions): Promise; } export interface CustomerProfiles { /** * Associates a new key value with a specific profile, such as a Contact Record ContactId. A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to. */ addProfileKey(input: AWS.CustomerProfiles.AddProfileKeyRequest, options: SdkCallOptions): Promise; /** * Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations. Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain. Use this API or UpdateDomain to enable identity resolution: set Matching to true. To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply. */ createDomain(input: AWS.CustomerProfiles.CreateDomainRequest, options: SdkCallOptions): Promise; /** * Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. */ createIntegrationWorkflow(input: AWS.CustomerProfiles.CreateIntegrationWorkflowRequest, options: SdkCallOptions): Promise; /** * Creates a standard profile. A standard profile represents the following attributes for a customer profile in a domain. */ createProfile(input: AWS.CustomerProfiles.CreateProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects. */ deleteDomain(input: AWS.CustomerProfiles.DeleteDomainRequest, options: SdkCallOptions): Promise; /** * Removes an integration from a specific domain. */ deleteIntegration(input: AWS.CustomerProfiles.DeleteIntegrationRequest, options: SdkCallOptions): Promise; /** * Deletes the standard customer profile and all data pertaining to the profile. */ deleteProfile(input: AWS.CustomerProfiles.DeleteProfileRequest, options: SdkCallOptions): Promise; /** * Removes a searchable key from a customer profile. */ deleteProfileKey(input: AWS.CustomerProfiles.DeleteProfileKeyRequest, options: SdkCallOptions): Promise; /** * Removes an object associated with a profile of a given ProfileObjectType. */ deleteProfileObject(input: AWS.CustomerProfiles.DeleteProfileObjectRequest, options: SdkCallOptions): Promise; /** * Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType. */ deleteProfileObjectType(input: AWS.CustomerProfiles.DeleteProfileObjectTypeRequest, options: SdkCallOptions): Promise; /** * Deletes the specified workflow and all its corresponding resources. This is an async process. */ deleteWorkflow(input: AWS.CustomerProfiles.DeleteWorkflowRequest, options: SdkCallOptions): Promise; /** * Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list. You can't view which profiles are matched and would be merged. We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName), there may be a large number of matches. This increases the chances of erroneous merges. */ getAutoMergingPreview(input: AWS.CustomerProfiles.GetAutoMergingPreviewRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific domain. */ getDomain(input: AWS.CustomerProfiles.GetDomainRequest, options: SdkCallOptions): Promise; /** * Returns information about an Identity Resolution Job in a specific domain. Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles. */ getIdentityResolutionJob(input: AWS.CustomerProfiles.GetIdentityResolutionJobRequest, options: SdkCallOptions): Promise; /** * Returns an integration for a domain. */ getIntegration(input: AWS.CustomerProfiles.GetIntegrationRequest, options: SdkCallOptions): Promise; /** * Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true. GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3. Amazon Connect uses the following profile attributes to identify matches: PhoneNumber HomePhoneNumber BusinessPhoneNumber MobilePhoneNumber EmailAddress PersonalEmailAddress BusinessEmailAddress FullName For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile. */ getMatches(input: AWS.CustomerProfiles.GetMatchesRequest, options: SdkCallOptions): Promise; /** * Returns the object types for a specific domain. */ getProfileObjectType(input: AWS.CustomerProfiles.GetProfileObjectTypeRequest, options: SdkCallOptions): Promise; /** * Returns the template information for a specific object type. A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template. */ getProfileObjectTypeTemplate(input: AWS.CustomerProfiles.GetProfileObjectTypeTemplateRequest, options: SdkCallOptions): Promise; /** * Get details of specified workflow. */ getWorkflow(input: AWS.CustomerProfiles.GetWorkflowRequest, options: SdkCallOptions): Promise; /** * Get granular list of steps in workflow. */ getWorkflowSteps(input: AWS.CustomerProfiles.GetWorkflowStepsRequest, options: SdkCallOptions): Promise; /** * Lists all of the integrations associated to a specific URI in the AWS account. */ listAccountIntegrations(input: AWS.CustomerProfiles.ListAccountIntegrationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all the domains for an AWS account that have been created. */ listDomains(input: AWS.CustomerProfiles.ListDomainsRequest, options: SdkCallOptions): Promise; /** * Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime. */ listIdentityResolutionJobs(input: AWS.CustomerProfiles.ListIdentityResolutionJobsRequest, options: SdkCallOptions): Promise; /** * Lists all of the integrations in your domain. */ listIntegrations(input: AWS.CustomerProfiles.ListIntegrationsRequest, options: SdkCallOptions): Promise; /** * Lists all of the template information for object types. */ listProfileObjectTypeTemplates(input: AWS.CustomerProfiles.ListProfileObjectTypeTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists all of the templates available within the service. */ listProfileObjectTypes(input: AWS.CustomerProfiles.ListProfileObjectTypesRequest, options: SdkCallOptions): Promise; /** * Returns a list of objects associated with a profile of a given ProfileObjectType. */ listProfileObjects(input: AWS.CustomerProfiles.ListProfileObjectsRequest, options: SdkCallOptions): Promise; /** * Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged. */ listTagsForResource(input: AWS.CustomerProfiles.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Query to list all workflows. */ listWorkflows(input: AWS.CustomerProfiles.ListWorkflowsRequest, options: SdkCallOptions): Promise; /** * Runs an AWS Lambda job that does the following: All the profileKeys in the ProfileToBeMerged will be moved to the main profile. All the objects in the ProfileToBeMerged will be moved to the main profile. All the ProfileToBeMerged will be deleted at the end. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile. Standard fields are merged as follows: Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys. When there are conflicting fields: If no SourceProfileIds entry is specified, the main Profile value is always taken. If a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value. You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged). */ mergeProfiles(input: AWS.CustomerProfiles.MergeProfilesRequest, options: SdkCallOptions): Promise; /** * Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect. An integration can belong to only one domain. To add or remove tags on an existing Integration, see TagResource / UntagResource. */ putIntegration(input: AWS.CustomerProfiles.PutIntegrationRequest, options: SdkCallOptions): Promise; /** * Adds additional objects to customer profiles of a given ObjectType. When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile. When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition. PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType. */ putProfileObject(input: AWS.CustomerProfiles.PutProfileObjectRequest, options: SdkCallOptions): Promise; /** * Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource/UntagResource. */ putProfileObjectType(input: AWS.CustomerProfiles.PutProfileObjectTypeRequest, options: SdkCallOptions): Promise; /** * Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index. */ searchProfiles(input: AWS.CustomerProfiles.SearchProfilesRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. */ tagResource(input: AWS.CustomerProfiles.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged. */ untagResource(input: AWS.CustomerProfiles.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key. After a domain is created, the name can’t be changed. Use this API or CreateDomain to enable identity resolution: set Matching to true. To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply. To add or remove tags on an existing Domain, see TagResource/UntagResource. */ updateDomain(input: AWS.CustomerProfiles.UpdateDomainRequest, options: SdkCallOptions): Promise; /** * Updates the properties of a profile. The ProfileId is required for updating a customer profile. When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept. */ updateProfile(input: AWS.CustomerProfiles.UpdateProfileRequest, options: SdkCallOptions): Promise; } export interface DataBrew { /** * Deletes one or more versions of a recipe at a time. The entire request will be rejected if: The recipe does not exist. There is an invalid version identifier in the list of versions. The version list is empty. The version list size exceeds 50. The version list contains duplicate entries. The request will complete successfully, but with partial failures, if: A version does not exist. A version is being used by a job. You specify LATEST_WORKING, but it's being used by a project. The version fails to be deleted. The LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then LATEST_WORKING will be listed as partial failure in the response. */ batchDeleteRecipeVersion(input: AWS.DataBrew.BatchDeleteRecipeVersionRequest, options: SdkCallOptions): Promise; /** * Creates a new DataBrew dataset. */ createDataset(input: AWS.DataBrew.CreateDatasetRequest, options: SdkCallOptions): Promise; /** * Creates a new job to analyze a dataset and create its data profile. */ createProfileJob(input: AWS.DataBrew.CreateProfileJobRequest, options: SdkCallOptions): Promise; /** * Creates a new DataBrew project. */ createProject(input: AWS.DataBrew.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Creates a new DataBrew recipe. */ createRecipe(input: AWS.DataBrew.CreateRecipeRequest, options: SdkCallOptions): Promise; /** * Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe */ createRecipeJob(input: AWS.DataBrew.CreateRecipeJobRequest, options: SdkCallOptions): Promise; /** * Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset. */ createRuleset(input: AWS.DataBrew.CreateRulesetRequest, options: SdkCallOptions): Promise; /** * Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals. */ createSchedule(input: AWS.DataBrew.CreateScheduleRequest, options: SdkCallOptions): Promise; /** * Deletes a dataset from DataBrew. */ deleteDataset(input: AWS.DataBrew.DeleteDatasetRequest, options: SdkCallOptions): Promise; /** * Deletes the specified DataBrew job. */ deleteJob(input: AWS.DataBrew.DeleteJobRequest, options: SdkCallOptions): Promise; /** * Deletes an existing DataBrew project. */ deleteProject(input: AWS.DataBrew.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Deletes a single version of a DataBrew recipe. */ deleteRecipeVersion(input: AWS.DataBrew.DeleteRecipeVersionRequest, options: SdkCallOptions): Promise; /** * Deletes a ruleset. */ deleteRuleset(input: AWS.DataBrew.DeleteRulesetRequest, options: SdkCallOptions): Promise; /** * Deletes the specified DataBrew schedule. */ deleteSchedule(input: AWS.DataBrew.DeleteScheduleRequest, options: SdkCallOptions): Promise; /** * Returns the definition of a specific DataBrew dataset. */ describeDataset(input: AWS.DataBrew.DescribeDatasetRequest, options: SdkCallOptions): Promise; /** * Returns the definition of a specific DataBrew job. */ describeJob(input: AWS.DataBrew.DescribeJobRequest, options: SdkCallOptions): Promise; /** * Represents one run of a DataBrew job. */ describeJobRun(input: AWS.DataBrew.DescribeJobRunRequest, options: SdkCallOptions): Promise; /** * Returns the definition of a specific DataBrew project. */ describeProject(input: AWS.DataBrew.DescribeProjectRequest, options: SdkCallOptions): Promise; /** * Returns the definition of a specific DataBrew recipe corresponding to a particular version. */ describeRecipe(input: AWS.DataBrew.DescribeRecipeRequest, options: SdkCallOptions): Promise; /** * Retrieves detailed information about the ruleset. */ describeRuleset(input: AWS.DataBrew.DescribeRulesetRequest, options: SdkCallOptions): Promise; /** * Returns the definition of a specific DataBrew schedule. */ describeSchedule(input: AWS.DataBrew.DescribeScheduleRequest, options: SdkCallOptions): Promise; /** * Lists all of the DataBrew datasets. */ listDatasets(input: AWS.DataBrew.ListDatasetsRequest, options: SdkCallOptions): Promise; /** * Lists all of the previous runs of a particular DataBrew job. */ listJobRuns(input: AWS.DataBrew.ListJobRunsRequest, options: SdkCallOptions): Promise; /** * Lists all of the DataBrew jobs that are defined. */ listJobs(input: AWS.DataBrew.ListJobsRequest, options: SdkCallOptions): Promise; /** * Lists all of the DataBrew projects that are defined. */ listProjects(input: AWS.DataBrew.ListProjectsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING. */ listRecipeVersions(input: AWS.DataBrew.ListRecipeVersionsRequest, options: SdkCallOptions): Promise; /** * Lists all of the DataBrew recipes that are defined. */ listRecipes(input: AWS.DataBrew.ListRecipesRequest, options: SdkCallOptions): Promise; /** * List all rulesets available in the current account or rulesets associated with a specific resource (dataset). */ listRulesets(input: AWS.DataBrew.ListRulesetsRequest, options: SdkCallOptions): Promise; /** * Lists the DataBrew schedules that are defined. */ listSchedules(input: AWS.DataBrew.ListSchedulesRequest, options: SdkCallOptions): Promise; /** * Lists all the tags for a DataBrew resource. */ listTagsForResource(input: AWS.DataBrew.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Publishes a new version of a DataBrew recipe. */ publishRecipe(input: AWS.DataBrew.PublishRecipeRequest, options: SdkCallOptions): Promise; /** * Performs a recipe step within an interactive DataBrew session that's currently open. */ sendProjectSessionAction(input: AWS.DataBrew.SendProjectSessionActionRequest, options: SdkCallOptions): Promise; /** * Runs a DataBrew job. */ startJobRun(input: AWS.DataBrew.StartJobRunRequest, options: SdkCallOptions): Promise; /** * Creates an interactive session, enabling you to manipulate data in a DataBrew project. */ startProjectSession(input: AWS.DataBrew.StartProjectSessionRequest, options: SdkCallOptions): Promise; /** * Stops a particular run of a job. */ stopJobRun(input: AWS.DataBrew.StopJobRunRequest, options: SdkCallOptions): Promise; /** * Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule. */ tagResource(input: AWS.DataBrew.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes metadata tags from a DataBrew resource. */ untagResource(input: AWS.DataBrew.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Modifies the definition of an existing DataBrew dataset. */ updateDataset(input: AWS.DataBrew.UpdateDatasetRequest, options: SdkCallOptions): Promise; /** * Modifies the definition of an existing profile job. */ updateProfileJob(input: AWS.DataBrew.UpdateProfileJobRequest, options: SdkCallOptions): Promise; /** * Modifies the definition of an existing DataBrew project. */ updateProject(input: AWS.DataBrew.UpdateProjectRequest, options: SdkCallOptions): Promise; /** * Modifies the definition of the LATEST_WORKING version of a DataBrew recipe. */ updateRecipe(input: AWS.DataBrew.UpdateRecipeRequest, options: SdkCallOptions): Promise; /** * Modifies the definition of an existing DataBrew recipe job. */ updateRecipeJob(input: AWS.DataBrew.UpdateRecipeJobRequest, options: SdkCallOptions): Promise; /** * Updates specified ruleset. */ updateRuleset(input: AWS.DataBrew.UpdateRulesetRequest, options: SdkCallOptions): Promise; /** * Modifies the definition of an existing DataBrew schedule. */ updateSchedule(input: AWS.DataBrew.UpdateScheduleRequest, options: SdkCallOptions): Promise; } export interface DataExchange { /** * This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state. */ cancelJob(input: AWS.DataExchange.CancelJobRequest, options: SdkCallOptions): Promise<{}>; /** * This operation creates a data set. */ createDataSet(input: AWS.DataExchange.CreateDataSetRequest, options: SdkCallOptions): Promise; /** * This operation creates an event action. */ createEventAction(input: AWS.DataExchange.CreateEventActionRequest, options: SdkCallOptions): Promise; /** * This operation creates a job. */ createJob(input: AWS.DataExchange.CreateJobRequest, options: SdkCallOptions): Promise; /** * This operation creates a revision for a data set. */ createRevision(input: AWS.DataExchange.CreateRevisionRequest, options: SdkCallOptions): Promise; /** * This operation deletes an asset. */ deleteAsset(input: AWS.DataExchange.DeleteAssetRequest, options: SdkCallOptions): Promise<{}>; /** * This operation deletes a data set. */ deleteDataSet(input: AWS.DataExchange.DeleteDataSetRequest, options: SdkCallOptions): Promise<{}>; /** * This operation deletes the event action. */ deleteEventAction(input: AWS.DataExchange.DeleteEventActionRequest, options: SdkCallOptions): Promise<{}>; /** * This operation deletes a revision. */ deleteRevision(input: AWS.DataExchange.DeleteRevisionRequest, options: SdkCallOptions): Promise<{}>; /** * This operation returns information about an asset. */ getAsset(input: AWS.DataExchange.GetAssetRequest, options: SdkCallOptions): Promise; /** * This operation returns information about a data set. */ getDataSet(input: AWS.DataExchange.GetDataSetRequest, options: SdkCallOptions): Promise; /** * This operation retrieves information about an event action. */ getEventAction(input: AWS.DataExchange.GetEventActionRequest, options: SdkCallOptions): Promise; /** * This operation returns information about a job. */ getJob(input: AWS.DataExchange.GetJobRequest, options: SdkCallOptions): Promise; /** * This operation returns information about a revision. */ getRevision(input: AWS.DataExchange.GetRevisionRequest, options: SdkCallOptions): Promise; /** * This operation lists a data set's revisions sorted by CreatedAt in descending order. */ listDataSetRevisions(input: AWS.DataExchange.ListDataSetRevisionsRequest, options: SdkCallOptions): Promise; /** * This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored. */ listDataSets(input: AWS.DataExchange.ListDataSetsRequest, options: SdkCallOptions): Promise; /** * This operation lists your event actions. */ listEventActions(input: AWS.DataExchange.ListEventActionsRequest, options: SdkCallOptions): Promise; /** * This operation lists your jobs sorted by CreatedAt in descending order. */ listJobs(input: AWS.DataExchange.ListJobsRequest, options: SdkCallOptions): Promise; /** * This operation lists a revision's assets sorted alphabetically in descending order. */ listRevisionAssets(input: AWS.DataExchange.ListRevisionAssetsRequest, options: SdkCallOptions): Promise; /** * This operation lists the tags on the resource. */ listTagsForResource(input: AWS.DataExchange.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * This operation revokes subscribers' access to a revision. */ revokeRevision(input: AWS.DataExchange.RevokeRevisionRequest, options: SdkCallOptions): Promise; /** * This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API. */ sendApiAsset(input: AWS.DataExchange.SendApiAssetRequest, options: SdkCallOptions): Promise; /** * This operation starts a job. */ startJob(input: AWS.DataExchange.StartJobRequest, options: SdkCallOptions): Promise; /** * This operation tags a resource. */ tagResource(input: AWS.DataExchange.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * This operation removes one or more tags from a resource. */ untagResource(input: AWS.DataExchange.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * This operation updates an asset. */ updateAsset(input: AWS.DataExchange.UpdateAssetRequest, options: SdkCallOptions): Promise; /** * This operation updates a data set. */ updateDataSet(input: AWS.DataExchange.UpdateDataSetRequest, options: SdkCallOptions): Promise; /** * This operation updates the event action. */ updateEventAction(input: AWS.DataExchange.UpdateEventActionRequest, options: SdkCallOptions): Promise; /** * This operation updates a revision. */ updateRevision(input: AWS.DataExchange.UpdateRevisionRequest, options: SdkCallOptions): Promise; } export interface DataPipeline { /** * Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline. To activate a finished pipeline, modify the end date for the pipeline and then activate it. */ activatePipeline(input: AWS.DataPipeline.ActivatePipelineInput, options: SdkCallOptions): Promise; /** * Adds or modifies tags for the specified pipeline. */ addTags(input: AWS.DataPipeline.AddTagsInput, options: SdkCallOptions): Promise; /** * Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. */ createPipeline(input: AWS.DataPipeline.CreatePipelineInput, options: SdkCallOptions): Promise; /** * Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes. To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. */ deactivatePipeline(input: AWS.DataPipeline.DeactivatePipelineInput, options: SdkCallOptions): Promise; /** * Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed. */ deletePipeline(input: AWS.DataPipeline.DeletePipelineInput, options: SdkCallOptions): Promise<{}>; /** * Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. */ describeObjects(input: AWS.DataPipeline.DescribeObjectsInput, options: SdkCallOptions): Promise; /** * Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition. */ describePipelines(input: AWS.DataPipeline.DescribePipelinesInput, options: SdkCallOptions): Promise; /** * Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. */ evaluateExpression(input: AWS.DataPipeline.EvaluateExpressionInput, options: SdkCallOptions): Promise; /** * Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition. */ getPipelineDefinition(input: AWS.DataPipeline.GetPipelineDefinitionInput, options: SdkCallOptions): Promise; /** * Lists the pipeline identifiers for all active pipelines that you have permission to access. */ listPipelines(input: AWS.DataPipeline.ListPipelinesInput, options: SdkCallOptions): Promise; /** * Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds. */ pollForTask(input: AWS.DataPipeline.PollForTaskInput, options: SdkCallOptions): Promise; /** * Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. An object is missing a name or identifier field. A string or reference field is empty. The number of objects in the pipeline exceeds the maximum allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. */ putPipelineDefinition(input: AWS.DataPipeline.PutPipelineDefinitionInput, options: SdkCallOptions): Promise; /** * Queries the specified pipeline for the names of objects that match the specified set of conditions. */ queryObjects(input: AWS.DataPipeline.QueryObjectsInput, options: SdkCallOptions): Promise; /** * Removes existing tags from the specified pipeline. */ removeTags(input: AWS.DataPipeline.RemoveTagsInput, options: SdkCallOptions): Promise; /** * Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds. */ reportTaskProgress(input: AWS.DataPipeline.ReportTaskProgressInput, options: SdkCallOptions): Promise; /** * Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. */ reportTaskRunnerHeartbeat(input: AWS.DataPipeline.ReportTaskRunnerHeartbeatInput, options: SdkCallOptions): Promise; /** * Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException. */ setStatus(input: AWS.DataPipeline.SetStatusInput, options: SdkCallOptions): Promise<{}>; /** * Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress. */ setTaskStatus(input: AWS.DataPipeline.SetTaskStatusInput, options: SdkCallOptions): Promise; /** * Validates the specified pipeline definition to ensure that it is well formed and can be run without error. */ validatePipelineDefinition(input: AWS.DataPipeline.ValidatePipelineDefinitionInput, options: SdkCallOptions): Promise; } export interface DataSync { /** * Cancels execution of a task. When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution. */ cancelTaskExecution(input: AWS.DataSync.CancelTaskExecutionRequest, options: SdkCallOptions): Promise; /** * Activates an DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region. You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet. You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks. */ createAgent(input: AWS.DataSync.CreateAgentRequest, options: SdkCallOptions): Promise; /** * Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS. */ createLocationEfs(input: AWS.DataSync.CreateLocationEfsRequest, options: SdkCallOptions): Promise; /** * Creates an endpoint for an Amazon FSx for Lustre file system. */ createLocationFsxLustre(input: AWS.DataSync.CreateLocationFsxLustreRequest, options: SdkCallOptions): Promise; /** * Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP. */ createLocationFsxOntap(input: AWS.DataSync.CreateLocationFsxOntapRequest, options: SdkCallOptions): Promise; /** * Creates an endpoint for an Amazon FSx for OpenZFS file system. */ createLocationFsxOpenZfs(input: AWS.DataSync.CreateLocationFsxOpenZfsRequest, options: SdkCallOptions): Promise; /** * Creates an endpoint for an Amazon FSx for Windows File Server file system. */ createLocationFsxWindows(input: AWS.DataSync.CreateLocationFsxWindowsRequest, options: SdkCallOptions): Promise; /** * Creates an endpoint for a Hadoop Distributed File System (HDFS). */ createLocationHdfs(input: AWS.DataSync.CreateLocationHdfsRequest, options: SdkCallOptions): Promise; /** * Defines a file system on a Network File System (NFS) server that can be read from or written to. */ createLocationNfs(input: AWS.DataSync.CreateLocationNfsRequest, options: SdkCallOptions): Promise; /** * Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage. */ createLocationObjectStorage(input: AWS.DataSync.CreateLocationObjectStorageRequest, options: SdkCallOptions): Promise; /** * Creates an endpoint for an Amazon S3 bucket. For more information, see Create an Amazon S3 location in the DataSync User Guide. */ createLocationS3(input: AWS.DataSync.CreateLocationS3Request, options: SdkCallOptions): Promise; /** * Defines a file system on a Server Message Block (SMB) server that can be read from or written to. */ createLocationSmb(input: AWS.DataSync.CreateLocationSmbRequest, options: SdkCallOptions): Promise; /** * Configures a task, which defines where and how DataSync transfers your data. A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options). When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of your locations must reside in the Region where you're using DataSync. For more information, see the following topics: Working with DataSync locations Configure DataSync task settings */ createTask(input: AWS.DataSync.CreateTaskRequest, options: SdkCallOptions): Promise; /** * Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment. */ deleteAgent(input: AWS.DataSync.DeleteAgentRequest, options: SdkCallOptions): Promise; /** * Deletes the configuration of a location used by DataSync. */ deleteLocation(input: AWS.DataSync.DeleteLocationRequest, options: SdkCallOptions): Promise; /** * Deletes a task. */ deleteTask(input: AWS.DataSync.DeleteTaskRequest, options: SdkCallOptions): Promise; /** * Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request. */ describeAgent(input: AWS.DataSync.DescribeAgentRequest, options: SdkCallOptions): Promise; /** * Returns metadata about your DataSync location for an Amazon EFS file system. */ describeLocationEfs(input: AWS.DataSync.DescribeLocationEfsRequest, options: SdkCallOptions): Promise; /** * Returns metadata about an Amazon FSx for Lustre location, such as information about its path. */ describeLocationFsxLustre(input: AWS.DataSync.DescribeLocationFsxLustreRequest, options: SdkCallOptions): Promise; /** * Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured. */ describeLocationFsxOntap(input: AWS.DataSync.DescribeLocationFsxOntapRequest, options: SdkCallOptions): Promise; /** * Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path. */ describeLocationFsxOpenZfs(input: AWS.DataSync.DescribeLocationFsxOpenZfsRequest, options: SdkCallOptions): Promise; /** * Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path. */ describeLocationFsxWindows(input: AWS.DataSync.DescribeLocationFsxWindowsRequest, options: SdkCallOptions): Promise; /** * Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location. */ describeLocationHdfs(input: AWS.DataSync.DescribeLocationHdfsRequest, options: SdkCallOptions): Promise; /** * Returns metadata, such as the path information, about an NFS location. */ describeLocationNfs(input: AWS.DataSync.DescribeLocationNfsRequest, options: SdkCallOptions): Promise; /** * Returns metadata about your DataSync location for an object storage system. */ describeLocationObjectStorage(input: AWS.DataSync.DescribeLocationObjectStorageRequest, options: SdkCallOptions): Promise; /** * Returns metadata, such as bucket name, about an Amazon S3 bucket location. */ describeLocationS3(input: AWS.DataSync.DescribeLocationS3Request, options: SdkCallOptions): Promise; /** * Returns metadata, such as the path and user information about an SMB location. */ describeLocationSmb(input: AWS.DataSync.DescribeLocationSmbRequest, options: SdkCallOptions): Promise; /** * Returns metadata about a task. */ describeTask(input: AWS.DataSync.DescribeTaskRequest, options: SdkCallOptions): Promise; /** * Returns detailed metadata about a task that is being executed. */ describeTaskExecution(input: AWS.DataSync.DescribeTaskExecutionRequest, options: SdkCallOptions): Promise; /** * Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN). By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response. If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents. */ listAgents(input: AWS.DataSync.ListAgentsRequest, options: SdkCallOptions): Promise; /** * Returns a list of source and destination locations. If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations. */ listLocations(input: AWS.DataSync.ListLocationsRequest, options: SdkCallOptions): Promise; /** * Returns all the tags associated with a specified resource. */ listTagsForResource(input: AWS.DataSync.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of executed tasks. */ listTaskExecutions(input: AWS.DataSync.ListTaskExecutionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the DataSync tasks you created. */ listTasks(input: AWS.DataSync.ListTasksRequest, options: SdkCallOptions): Promise; /** * Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time. TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. For detailed information, see the Task Execution section in the Components and Terminology topic in the DataSync User Guide. */ startTaskExecution(input: AWS.DataSync.StartTaskExecutionRequest, options: SdkCallOptions): Promise; /** * Applies a key-value pair to an Amazon Web Services resource. */ tagResource(input: AWS.DataSync.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from an Amazon Web Services resource. */ untagResource(input: AWS.DataSync.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the name of an agent. */ updateAgent(input: AWS.DataSync.UpdateAgentRequest, options: SdkCallOptions): Promise; /** * Updates some parameters of a previously created location for a Hadoop Distributed File System cluster. */ updateLocationHdfs(input: AWS.DataSync.UpdateLocationHdfsRequest, options: SdkCallOptions): Promise; /** * Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS. */ updateLocationNfs(input: AWS.DataSync.UpdateLocationNfsRequest, options: SdkCallOptions): Promise; /** * Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage. */ updateLocationObjectStorage(input: AWS.DataSync.UpdateLocationObjectStorageRequest, options: SdkCallOptions): Promise; /** * Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB. */ updateLocationSmb(input: AWS.DataSync.UpdateLocationSmbRequest, options: SdkCallOptions): Promise; /** * Updates the metadata associated with a task. */ updateTask(input: AWS.DataSync.UpdateTaskRequest, options: SdkCallOptions): Promise; /** * Updates execution of a task. You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution. The only Option that can be modified by UpdateTaskExecution is BytesPerSecond . */ updateTaskExecution(input: AWS.DataSync.UpdateTaskExecutionRequest, options: SdkCallOptions): Promise; } export interface DAX { /** * Creates a DAX cluster. All nodes in the cluster run the same DAX caching software. */ createCluster(input: AWS.DAX.CreateClusterRequest, options: SdkCallOptions): Promise; /** * Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster. */ createParameterGroup(input: AWS.DAX.CreateParameterGroupRequest, options: SdkCallOptions): Promise; /** * Creates a new subnet group. */ createSubnetGroup(input: AWS.DAX.CreateSubnetGroupRequest, options: SdkCallOptions): Promise; /** * Removes one or more nodes from a DAX cluster. You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead. */ decreaseReplicationFactor(input: AWS.DAX.DecreaseReplicationFactorRequest, options: SdkCallOptions): Promise; /** * Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action. */ deleteCluster(input: AWS.DAX.DeleteClusterRequest, options: SdkCallOptions): Promise; /** * Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters. */ deleteParameterGroup(input: AWS.DAX.DeleteParameterGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters. */ deleteSubnetGroup(input: AWS.DAX.DeleteSubnetGroupRequest, options: SdkCallOptions): Promise; /** * Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied. If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. If the cluster is in the DELETING state, only cluster level information will be displayed. If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use. If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed. */ describeClusters(input: AWS.DAX.DescribeClustersRequest, options: SdkCallOptions): Promise; /** * Returns the default system parameter information for the DAX caching software. */ describeDefaultParameters(input: AWS.DAX.DescribeDefaultParametersRequest, options: SdkCallOptions): Promise; /** * Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter. By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary. */ describeEvents(input: AWS.DAX.DescribeEventsRequest, options: SdkCallOptions): Promise; /** * Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group. */ describeParameterGroups(input: AWS.DAX.DescribeParameterGroupsRequest, options: SdkCallOptions): Promise; /** * Returns the detailed parameter list for a particular parameter group. */ describeParameters(input: AWS.DAX.DescribeParametersRequest, options: SdkCallOptions): Promise; /** * Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. */ describeSubnetGroups(input: AWS.DAX.DescribeSubnetGroupsRequest, options: SdkCallOptions): Promise; /** * Adds one or more nodes to a DAX cluster. */ increaseReplicationFactor(input: AWS.DAX.IncreaseReplicationFactorRequest, options: SdkCallOptions): Promise; /** * List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account. */ listTags(input: AWS.DAX.ListTagsRequest, options: SdkCallOptions): Promise; /** * Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING. RebootNode restarts the DAX engine process and does not remove the contents of the cache. */ rebootNode(input: AWS.DAX.RebootNodeRequest, options: SdkCallOptions): Promise; /** * Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account. */ tagResource(input: AWS.DAX.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account. */ untagResource(input: AWS.DAX.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values. */ updateCluster(input: AWS.DAX.UpdateClusterRequest, options: SdkCallOptions): Promise; /** * Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. */ updateParameterGroup(input: AWS.DAX.UpdateParameterGroupRequest, options: SdkCallOptions): Promise; /** * Modifies an existing subnet group. */ updateSubnetGroup(input: AWS.DAX.UpdateSubnetGroupRequest, options: SdkCallOptions): Promise; } export interface Detective { /** * Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account. The request provides the ARN of behavior graph. The member account status in the graph must be INVITED. */ acceptInvitation(input: AWS.Detective.AcceptInvitationRequest, options: SdkCallOptions): Promise<{}>; /** * Gets data source package information for the behavior graph. */ batchGetGraphMemberDatasources(input: AWS.Detective.BatchGetGraphMemberDatasourcesRequest, options: SdkCallOptions): Promise; /** * Gets information on the data source package history for an account. */ batchGetMembershipDatasources(input: AWS.Detective.BatchGetMembershipDatasourcesRequest, options: SdkCallOptions): Promise; /** * Creates a new behavior graph for the calling account, and sets that account as the administrator account. This operation is called by the account that is enabling Detective. Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective. The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph. CreateGraph triggers a process to create the corresponding data tables for the new behavior graph. An account can only be the administrator account for one behavior graph within a Region. If the same account calls CreateGraph with the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph. */ createGraph(input: AWS.Detective.CreateGraphRequest, options: SdkCallOptions): Promise; /** * CreateMembers is used to send invitations to accounts. For the organization behavior graph, the Detective administrator account uses CreateMembers to enable organization accounts as member accounts. For invited accounts, CreateMembers sends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph. CreateMembers verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally. For organization accounts in the organization behavior graph, CreateMembers attempts to enable the accounts. The organization accounts do not receive invitations. The request provides the behavior graph ARN and the list of accounts to invite or to enable. The response separates the requested accounts into two lists: The accounts that CreateMembers was able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled. The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph. */ createMembers(input: AWS.Detective.CreateMembersRequest, options: SdkCallOptions): Promise; /** * Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs. DeleteGraph can only be called by the administrator account for a behavior graph. */ deleteGraph(input: AWS.Detective.DeleteGraphRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph. For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation. For organization accounts in the organization behavior graph, the Detective administrator account can always enable the organization account again. Organization accounts that are not enabled as member accounts are not included in the ListMembers results for the organization behavior graph. An administrator account cannot use DeleteMembers to remove their own account from the behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method. */ deleteMembers(input: AWS.Detective.DeleteMembersRequest, options: SdkCallOptions): Promise; /** * Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts. Can only be called by the Detective administrator account for the organization. */ describeOrganizationConfiguration(input: AWS.Detective.DescribeOrganizationConfigurationRequest, options: SdkCallOptions): Promise; /** * Removes the member account from the specified behavior graph. This operation can only be called by an invited member account that has the ENABLED status. DisassociateMembership cannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts. */ disassociateMembership(input: AWS.Detective.DisassociateMembershipRequest, options: SdkCallOptions): Promise<{}>; /** * Designates the Detective administrator account for the organization in the current Region. If the account does not have Detective enabled, then enables Detective for that account and creates a new behavior graph. Can only be called by the organization management account. If the organization has a delegated administrator account in Organizations, then the Detective administrator account must be either the delegated administrator account or the organization management account. If the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other than the organization management account, Detective calls Organizations to make that account the delegated administrator account for Detective. The organization management account cannot be the delegated administrator account. */ enableOrganizationAdminAccount(input: AWS.Detective.EnableOrganizationAdminAccountRequest, options: SdkCallOptions): Promise<{}>; /** * Returns the membership details for specified member accounts for a behavior graph. */ getMembers(input: AWS.Detective.GetMembersRequest, options: SdkCallOptions): Promise; /** * Lists data source packages in the behavior graph. */ listDatasourcePackages(input: AWS.Detective.ListDatasourcePackagesRequest, options: SdkCallOptions): Promise; /** * Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account. Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph. */ listGraphs(input: AWS.Detective.ListGraphsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account. Open invitations are invitations that the member account has not responded to. The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from. */ listInvitations(input: AWS.Detective.ListInvitationsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of member accounts for a behavior graph. For invited accounts, the results do not include member accounts that were removed from the behavior graph. For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts. */ listMembers(input: AWS.Detective.ListMembersRequest, options: SdkCallOptions): Promise; /** * Returns information about the Detective administrator account for an organization. Can only be called by the organization management account. */ listOrganizationAdminAccounts(input: AWS.Detective.ListOrganizationAdminAccountsRequest, options: SdkCallOptions): Promise; /** * Returns the tag values that are assigned to a behavior graph. */ listTagsForResource(input: AWS.Detective.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by an invited member account that has the INVITED status. RejectInvitation cannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation. */ rejectInvitation(input: AWS.Detective.RejectInvitationRequest, options: SdkCallOptions): Promise<{}>; /** * Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED. For valid member accounts, the status is updated as follows. If Detective enabled the member account, then the new status is ENABLED. If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED. */ startMonitoringMember(input: AWS.Detective.StartMonitoringMemberRequest, options: SdkCallOptions): Promise<{}>; /** * Applies tag values to a behavior graph. */ tagResource(input: AWS.Detective.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a behavior graph. */ untagResource(input: AWS.Detective.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Starts a data source packages for the behavior graph. */ updateDatasourcePackages(input: AWS.Detective.UpdateDatasourcePackagesRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization. */ updateOrganizationConfiguration(input: AWS.Detective.UpdateOrganizationConfigurationRequest, options: SdkCallOptions): Promise<{}>; } export interface DeviceFarm { /** * Creates a device pool. */ createDevicePool(input: AWS.DeviceFarm.CreateDevicePoolRequest, options: SdkCallOptions): Promise; /** * Creates a profile that can be applied to one or more private fleet device instances. */ createInstanceProfile(input: AWS.DeviceFarm.CreateInstanceProfileRequest, options: SdkCallOptions): Promise; /** * Creates a network profile. */ createNetworkProfile(input: AWS.DeviceFarm.CreateNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Creates a project. */ createProject(input: AWS.DeviceFarm.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Specifies and starts a remote access session. */ createRemoteAccessSession(input: AWS.DeviceFarm.CreateRemoteAccessSessionRequest, options: SdkCallOptions): Promise; /** * Creates a Selenium testing project. Projects are used to track TestGridSession instances. */ createTestGridProject(input: AWS.DeviceFarm.CreateTestGridProjectRequest, options: SdkCallOptions): Promise; /** * Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor. */ createTestGridUrl(input: AWS.DeviceFarm.CreateTestGridUrlRequest, options: SdkCallOptions): Promise; /** * Uploads an app or test scripts. */ createUpload(input: AWS.DeviceFarm.CreateUploadRequest, options: SdkCallOptions): Promise; /** * Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint. */ createVPCEConfiguration(input: AWS.DeviceFarm.CreateVPCEConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. */ deleteDevicePool(input: AWS.DeviceFarm.DeleteDevicePoolRequest, options: SdkCallOptions): Promise; /** * Deletes a profile that can be applied to one or more private device instances. */ deleteInstanceProfile(input: AWS.DeviceFarm.DeleteInstanceProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a network profile. */ deleteNetworkProfile(input: AWS.DeviceFarm.DeleteNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Deletes an AWS Device Farm project, given the project ARN. Deleting this resource does not stop an in-progress run. */ deleteProject(input: AWS.DeviceFarm.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Deletes a completed remote access session and its results. */ deleteRemoteAccessSession(input: AWS.DeviceFarm.DeleteRemoteAccessSessionRequest, options: SdkCallOptions): Promise; /** * Deletes the run, given the run ARN. Deleting this resource does not stop an in-progress run. */ deleteRun(input: AWS.DeviceFarm.DeleteRunRequest, options: SdkCallOptions): Promise; /** * Deletes a Selenium testing project and all content generated under it. You cannot undo this operation. You cannot delete a project if it has active sessions. */ deleteTestGridProject(input: AWS.DeviceFarm.DeleteTestGridProjectRequest, options: SdkCallOptions): Promise; /** * Deletes an upload given the upload ARN. */ deleteUpload(input: AWS.DeviceFarm.DeleteUploadRequest, options: SdkCallOptions): Promise; /** * Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint. */ deleteVPCEConfiguration(input: AWS.DeviceFarm.DeleteVPCEConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account. */ getAccountSettings(input: AWS.DeviceFarm.GetAccountSettingsRequest, options: SdkCallOptions): Promise; /** * Gets information about a unique device type. */ getDevice(input: AWS.DeviceFarm.GetDeviceRequest, options: SdkCallOptions): Promise; /** * Returns information about a device instance that belongs to a private device fleet. */ getDeviceInstance(input: AWS.DeviceFarm.GetDeviceInstanceRequest, options: SdkCallOptions): Promise; /** * Gets information about a device pool. */ getDevicePool(input: AWS.DeviceFarm.GetDevicePoolRequest, options: SdkCallOptions): Promise; /** * Gets information about compatibility with a device pool. */ getDevicePoolCompatibility(input: AWS.DeviceFarm.GetDevicePoolCompatibilityRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified instance profile. */ getInstanceProfile(input: AWS.DeviceFarm.GetInstanceProfileRequest, options: SdkCallOptions): Promise; /** * Gets information about a job. */ getJob(input: AWS.DeviceFarm.GetJobRequest, options: SdkCallOptions): Promise; /** * Returns information about a network profile. */ getNetworkProfile(input: AWS.DeviceFarm.GetNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com. */ getOfferingStatus(input: AWS.DeviceFarm.GetOfferingStatusRequest, options: SdkCallOptions): Promise; /** * Gets information about a project. */ getProject(input: AWS.DeviceFarm.GetProjectRequest, options: SdkCallOptions): Promise; /** * Returns a link to a currently running remote access session. */ getRemoteAccessSession(input: AWS.DeviceFarm.GetRemoteAccessSessionRequest, options: SdkCallOptions): Promise; /** * Gets information about a run. */ getRun(input: AWS.DeviceFarm.GetRunRequest, options: SdkCallOptions): Promise; /** * Gets information about a suite. */ getSuite(input: AWS.DeviceFarm.GetSuiteRequest, options: SdkCallOptions): Promise; /** * Gets information about a test. */ getTest(input: AWS.DeviceFarm.GetTestRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a Selenium testing project. */ getTestGridProject(input: AWS.DeviceFarm.GetTestGridProjectRequest, options: SdkCallOptions): Promise; /** * A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url. You can use the following to look up sessions: The session ARN (GetTestGridSessionRequest$sessionArn). The project ARN and a session ID (GetTestGridSessionRequest$projectArn and GetTestGridSessionRequest$sessionId). */ getTestGridSession(input: AWS.DeviceFarm.GetTestGridSessionRequest, options: SdkCallOptions): Promise; /** * Gets information about an upload. */ getUpload(input: AWS.DeviceFarm.GetUploadRequest, options: SdkCallOptions): Promise; /** * Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint. */ getVPCEConfiguration(input: AWS.DeviceFarm.GetVPCEConfigurationRequest, options: SdkCallOptions): Promise; /** * Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format. */ installToRemoteAccessSession(input: AWS.DeviceFarm.InstallToRemoteAccessSessionRequest, options: SdkCallOptions): Promise; /** * Gets information about artifacts. */ listArtifacts(input: AWS.DeviceFarm.ListArtifactsRequest, options: SdkCallOptions): Promise; /** * Returns information about the private device instances associated with one or more AWS accounts. */ listDeviceInstances(input: AWS.DeviceFarm.ListDeviceInstancesRequest, options: SdkCallOptions): Promise; /** * Gets information about device pools. */ listDevicePools(input: AWS.DeviceFarm.ListDevicePoolsRequest, options: SdkCallOptions): Promise; /** * Gets information about unique device types. */ listDevices(input: AWS.DeviceFarm.ListDevicesRequest, options: SdkCallOptions): Promise; /** * Returns information about all the instance profiles in an AWS account. */ listInstanceProfiles(input: AWS.DeviceFarm.ListInstanceProfilesRequest, options: SdkCallOptions): Promise; /** * Gets information about jobs for a given test run. */ listJobs(input: AWS.DeviceFarm.ListJobsRequest, options: SdkCallOptions): Promise; /** * Returns the list of available network profiles. */ listNetworkProfiles(input: AWS.DeviceFarm.ListNetworkProfilesRequest, options: SdkCallOptions): Promise; /** * Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you must be able to invoke this operation. */ listOfferingPromotions(input: AWS.DeviceFarm.ListOfferingPromotionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com. */ listOfferingTransactions(input: AWS.DeviceFarm.ListOfferingTransactionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com. */ listOfferings(input: AWS.DeviceFarm.ListOfferingsRequest, options: SdkCallOptions): Promise; /** * Gets information about projects. */ listProjects(input: AWS.DeviceFarm.ListProjectsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all currently running remote access sessions. */ listRemoteAccessSessions(input: AWS.DeviceFarm.ListRemoteAccessSessionsRequest, options: SdkCallOptions): Promise; /** * Gets information about runs, given an AWS Device Farm project ARN. */ listRuns(input: AWS.DeviceFarm.ListRunsRequest, options: SdkCallOptions): Promise; /** * Gets information about samples, given an AWS Device Farm job ARN. */ listSamples(input: AWS.DeviceFarm.ListSamplesRequest, options: SdkCallOptions): Promise; /** * Gets information about test suites for a given job. */ listSuites(input: AWS.DeviceFarm.ListSuitesRequest, options: SdkCallOptions): Promise; /** * List the tags for an AWS Device Farm resource. */ listTagsForResource(input: AWS.DeviceFarm.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Gets a list of all Selenium testing projects in your account. */ listTestGridProjects(input: AWS.DeviceFarm.ListTestGridProjectsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the actions taken in a TestGridSession. */ listTestGridSessionActions(input: AWS.DeviceFarm.ListTestGridSessionActionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of artifacts created during the session. */ listTestGridSessionArtifacts(input: AWS.DeviceFarm.ListTestGridSessionArtifactsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of sessions for a TestGridProject. */ listTestGridSessions(input: AWS.DeviceFarm.ListTestGridSessionsRequest, options: SdkCallOptions): Promise; /** * Gets information about tests in a given test suite. */ listTests(input: AWS.DeviceFarm.ListTestsRequest, options: SdkCallOptions): Promise; /** * Gets information about unique problems, such as exceptions or crashes. Unique problems are defined as a single instance of an error across a run, job, or suite. For example, if a call in your application consistently raises an exception (OutOfBoundsException in MyActivity.java:386), ListUniqueProblems returns a single entry instead of many individual entries for that exception. */ listUniqueProblems(input: AWS.DeviceFarm.ListUniqueProblemsRequest, options: SdkCallOptions): Promise; /** * Gets information about uploads, given an AWS Device Farm project ARN. */ listUploads(input: AWS.DeviceFarm.ListUploadsRequest, options: SdkCallOptions): Promise; /** * Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account. */ listVPCEConfigurations(input: AWS.DeviceFarm.ListVPCEConfigurationsRequest, options: SdkCallOptions): Promise; /** * Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com. */ purchaseOffering(input: AWS.DeviceFarm.PurchaseOfferingRequest, options: SdkCallOptions): Promise; /** * Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com. */ renewOffering(input: AWS.DeviceFarm.RenewOfferingRequest, options: SdkCallOptions): Promise; /** * Schedules a run. */ scheduleRun(input: AWS.DeviceFarm.ScheduleRunRequest, options: SdkCallOptions): Promise; /** * Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed. */ stopJob(input: AWS.DeviceFarm.StopJobRequest, options: SdkCallOptions): Promise; /** * Ends a specified remote access session. */ stopRemoteAccessSession(input: AWS.DeviceFarm.StopRemoteAccessSessionRequest, options: SdkCallOptions): Promise; /** * Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed. */ stopRun(input: AWS.DeviceFarm.StopRunRequest, options: SdkCallOptions): Promise; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted. */ tagResource(input: AWS.DeviceFarm.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes the specified tags from a resource. */ untagResource(input: AWS.DeviceFarm.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates information about a private device instance. */ updateDeviceInstance(input: AWS.DeviceFarm.UpdateDeviceInstanceRequest, options: SdkCallOptions): Promise; /** * Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all). */ updateDevicePool(input: AWS.DeviceFarm.UpdateDevicePoolRequest, options: SdkCallOptions): Promise; /** * Updates information about an existing private device instance profile. */ updateInstanceProfile(input: AWS.DeviceFarm.UpdateInstanceProfileRequest, options: SdkCallOptions): Promise; /** * Updates the network profile. */ updateNetworkProfile(input: AWS.DeviceFarm.UpdateNetworkProfileRequest, options: SdkCallOptions): Promise; /** * Modifies the specified project name, given the project ARN and a new name. */ updateProject(input: AWS.DeviceFarm.UpdateProjectRequest, options: SdkCallOptions): Promise; /** * Change details of a project. */ updateTestGridProject(input: AWS.DeviceFarm.UpdateTestGridProjectRequest, options: SdkCallOptions): Promise; /** * Updates an uploaded test spec. */ updateUpload(input: AWS.DeviceFarm.UpdateUploadRequest, options: SdkCallOptions): Promise; /** * Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration. */ updateVPCEConfiguration(input: AWS.DeviceFarm.UpdateVPCEConfigurationRequest, options: SdkCallOptions): Promise; } export interface DevOpsGuru { /** * Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics. If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics. */ addNotificationChannel(input: AWS.DevOpsGuru.AddNotificationChannelRequest, options: SdkCallOptions): Promise; /** * Deletes the insight along with the associated anomalies, events and recommendations. */ deleteInsight(input: AWS.DevOpsGuru.DeleteInsightRequest, options: SdkCallOptions): Promise; /** * Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account. */ describeAccountHealth(input: AWS.DevOpsGuru.DescribeAccountHealthRequest, options: SdkCallOptions): Promise; /** * For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights. */ describeAccountOverview(input: AWS.DevOpsGuru.DescribeAccountOverviewRequest, options: SdkCallOptions): Promise; /** * Returns details about an anomaly that you specify using its ID. */ describeAnomaly(input: AWS.DevOpsGuru.DescribeAnomalyRequest, options: SdkCallOptions): Promise; /** * Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru. */ describeEventSourcesConfig(input: AWS.DevOpsGuru.DescribeEventSourcesConfigRequest, options: SdkCallOptions): Promise; /** * Returns the most recent feedback submitted in the current Amazon Web Services account and Region. */ describeFeedback(input: AWS.DevOpsGuru.DescribeFeedbackRequest, options: SdkCallOptions): Promise; /** * Returns details about an insight that you specify using its ID. */ describeInsight(input: AWS.DevOpsGuru.DescribeInsightRequest, options: SdkCallOptions): Promise; /** * Returns active insights, predictive insights, and resource hours analyzed in last hour. */ describeOrganizationHealth(input: AWS.DevOpsGuru.DescribeOrganizationHealthRequest, options: SdkCallOptions): Promise; /** * Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights. */ describeOrganizationOverview(input: AWS.DevOpsGuru.DescribeOrganizationOverviewRequest, options: SdkCallOptions): Promise; /** * Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field. */ describeOrganizationResourceCollectionHealth(input: AWS.DevOpsGuru.DescribeOrganizationResourceCollectionHealthRequest, options: SdkCallOptions): Promise; /** * Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. */ describeResourceCollectionHealth(input: AWS.DevOpsGuru.DescribeResourceCollectionHealthRequest, options: SdkCallOptions): Promise; /** * Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight. */ describeServiceIntegration(input: AWS.DevOpsGuru.DescribeServiceIntegrationRequest, options: SdkCallOptions): Promise; /** * Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing. */ getCostEstimation(input: AWS.DevOpsGuru.GetCostEstimationRequest, options: SdkCallOptions): Promise; /** * Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. */ getResourceCollection(input: AWS.DevOpsGuru.GetResourceCollectionRequest, options: SdkCallOptions): Promise; /** * Returns a list of the anomalies that belong to an insight that you specify using its ID. */ listAnomaliesForInsight(input: AWS.DevOpsGuru.ListAnomaliesForInsightRequest, options: SdkCallOptions): Promise; /** * Returns the list of log groups that contain log anomalies. */ listAnomalousLogGroups(input: AWS.DevOpsGuru.ListAnomalousLogGroupsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned. */ listEvents(input: AWS.DevOpsGuru.ListEventsRequest, options: SdkCallOptions): Promise; /** * Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY). */ listInsights(input: AWS.DevOpsGuru.ListInsightsRequest, options: SdkCallOptions): Promise; /** * Returns the list of all log groups that are being monitored and tagged by DevOps Guru. */ listMonitoredResources(input: AWS.DevOpsGuru.ListMonitoredResourcesRequest, options: SdkCallOptions): Promise; /** * Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS). */ listNotificationChannels(input: AWS.DevOpsGuru.ListNotificationChannelsRequest, options: SdkCallOptions): Promise; /** * Returns a list of insights associated with the account or OU Id. */ listOrganizationInsights(input: AWS.DevOpsGuru.ListOrganizationInsightsRequest, options: SdkCallOptions): Promise; /** * Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events. */ listRecommendations(input: AWS.DevOpsGuru.ListRecommendationsRequest, options: SdkCallOptions): Promise; /** * Collects customer feedback about the specified insight. */ putFeedback(input: AWS.DevOpsGuru.PutFeedbackRequest, options: SdkCallOptions): Promise; /** * Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. */ removeNotificationChannel(input: AWS.DevOpsGuru.RemoveNotificationChannelRequest, options: SdkCallOptions): Promise; /** * Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search. */ searchInsights(input: AWS.DevOpsGuru.SearchInsightsRequest, options: SdkCallOptions): Promise; /** * Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search. */ searchOrganizationInsights(input: AWS.DevOpsGuru.SearchOrganizationInsightsRequest, options: SdkCallOptions): Promise; /** * Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources. */ startCostEstimation(input: AWS.DevOpsGuru.StartCostEstimationRequest, options: SdkCallOptions): Promise; /** * Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru. */ updateEventSourcesConfig(input: AWS.DevOpsGuru.UpdateEventSourcesConfigRequest, options: SdkCallOptions): Promise; /** * Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru. */ updateResourceCollection(input: AWS.DevOpsGuru.UpdateResourceCollectionRequest, options: SdkCallOptions): Promise; /** * Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight. */ updateServiceIntegration(input: AWS.DevOpsGuru.UpdateServiceIntegrationRequest, options: SdkCallOptions): Promise; } export interface DirectConnect { /** * Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway. */ acceptDirectConnectGatewayAssociationProposal(input: AWS.DirectConnect.AcceptDirectConnectGatewayAssociationProposalRequest, options: SdkCallOptions): Promise; /** * Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection on an interconnect. Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect. Intended for use by Direct Connect Partners only. */ allocateConnectionOnInterconnect(input: AWS.DirectConnect.AllocateConnectionOnInterconnectRequest, options: SdkCallOptions): Promise; /** * Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects. Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity. Intended for use by Direct Connect Partners only. */ allocateHostedConnection(input: AWS.DirectConnect.AllocateHostedConnectionRequest, options: SdkCallOptions): Promise; /** * Provisions a private virtual interface to be owned by the specified Amazon Web Services account. Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic. */ allocatePrivateVirtualInterface(input: AWS.DirectConnect.AllocatePrivateVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Provisions a public virtual interface to be owned by the specified Amazon Web Services account. The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account. Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic. When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. */ allocatePublicVirtualInterface(input: AWS.DirectConnect.AllocatePublicVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway. The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account. After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic. */ allocateTransitVirtualInterface(input: AWS.DirectConnect.AllocateTransitVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails. Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG. For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG. */ associateConnectionWithLag(input: AWS.DirectConnect.AssociateConnectionWithLagRequest, options: SdkCallOptions): Promise; /** * Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to Amazon Web Services as it is being migrated. Intended for use by Direct Connect Partners only. */ associateHostedConnection(input: AWS.DirectConnect.AssociateHostedConnectionRequest, options: SdkCallOptions): Promise; /** * Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection. You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request. For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide. */ associateMacSecKey(input: AWS.DirectConnect.AssociateMacSecKeyRequest, options: SdkCallOptions): Promise; /** * Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection. To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association. */ associateVirtualInterface(input: AWS.DirectConnect.AssociateVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Confirms the creation of the specified hosted connection on an interconnect. Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection. */ confirmConnection(input: AWS.DirectConnect.ConfirmConnectionRequest, options: SdkCallOptions): Promise; /** * The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG). */ confirmCustomerAgreement(input: AWS.DirectConnect.ConfirmCustomerAgreementRequest, options: SdkCallOptions): Promise; /** * Accepts ownership of a private virtual interface created by another Amazon Web Services account. After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic. */ confirmPrivateVirtualInterface(input: AWS.DirectConnect.ConfirmPrivateVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Accepts ownership of a public virtual interface created by another Amazon Web Services account. After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic. */ confirmPublicVirtualInterface(input: AWS.DirectConnect.ConfirmPublicVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Accepts ownership of a transit virtual interface created by another Amazon Web Services account. After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic. */ confirmTransitVirtualInterface(input: AWS.DirectConnect.ConfirmTransitVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Creates a BGP peer on the specified virtual interface. You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family. If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface. When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface. */ createBGPPeer(input: AWS.DirectConnect.CreateBGPPeerRequest, options: SdkCallOptions): Promise; /** * Creates a connection between a customer network and a specific Direct Connect location. A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. To find the locations for your Region, use DescribeLocations. You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created. */ createConnection(input: AWS.DirectConnect.CreateConnectionRequest, options: SdkCallOptions): Promise; /** * Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them. */ createDirectConnectGateway(input: AWS.DirectConnect.CreateDirectConnectGatewayRequest, options: SdkCallOptions): Promise; /** * Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway. */ createDirectConnectGatewayAssociation(input: AWS.DirectConnect.CreateDirectConnectGatewayAssociationRequest, options: SdkCallOptions): Promise; /** * Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway. You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account. */ createDirectConnectGatewayAssociationProposal(input: AWS.DirectConnect.CreateDirectConnectGatewayAssociationProposalRequest, options: SdkCallOptions): Promise; /** * Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location. An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect router. You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created. For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner. Intended for use by Direct Connect Partners only. */ createInterconnect(input: AWS.DirectConnect.CreateInterconnectRequest, options: SdkCallOptions): Promise; /** * Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface. All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint. You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created. You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change. If the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured. */ createLag(input: AWS.DirectConnect.CreateLagRequest, options: SdkCallOptions): Promise; /** * Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region. Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces. */ createPrivateVirtualInterface(input: AWS.DirectConnect.CreatePrivateVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3. When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported. */ createPublicVirtualInterface(input: AWS.DirectConnect.CreatePublicVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway. If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails. Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces. */ createTransitVirtualInterface(input: AWS.DirectConnect.CreateTransitVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface. */ deleteBGPPeer(input: AWS.DirectConnect.DeleteBGPPeerRequest, options: SdkCallOptions): Promise; /** * Deletes the specified connection. Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the Direct Connect location, you must cancel your service with them separately. */ deleteConnection(input: AWS.DirectConnect.DeleteConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway. */ deleteDirectConnectGateway(input: AWS.DirectConnect.DeleteDirectConnectGatewayRequest, options: SdkCallOptions): Promise; /** * Deletes the association between the specified Direct Connect gateway and virtual private gateway. We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association. */ deleteDirectConnectGatewayAssociation(input: AWS.DirectConnect.DeleteDirectConnectGatewayAssociationRequest, options: SdkCallOptions): Promise; /** * Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway. */ deleteDirectConnectGatewayAssociationProposal(input: AWS.DirectConnect.DeleteDirectConnectGatewayAssociationProposalRequest, options: SdkCallOptions): Promise; /** * Deletes the specified interconnect. Intended for use by Direct Connect Partners only. */ deleteInterconnect(input: AWS.DirectConnect.DeleteInterconnectRequest, options: SdkCallOptions): Promise; /** * Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections. */ deleteLag(input: AWS.DirectConnect.DeleteLagRequest, options: SdkCallOptions): Promise; /** * Deletes a virtual interface. */ deleteVirtualInterface(input: AWS.DirectConnect.DeleteVirtualInterfaceRequest, options: SdkCallOptions): Promise; /** * Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for a connection. The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide. */ describeConnectionLoa(input: AWS.DirectConnect.DescribeConnectionLoaRequest, options: SdkCallOptions): Promise; /** * Displays the specified connection or all connections in this Region. */ describeConnections(input: AWS.DirectConnect.DescribeConnectionsRequest, options: SdkCallOptions): Promise; /** * Deprecated. Use DescribeHostedConnections instead. Lists the connections that have been provisioned on the specified interconnect. Intended for use by Direct Connect Partners only. */ describeConnectionsOnInterconnect(input: AWS.DirectConnect.DescribeConnectionsOnInterconnectRequest, options: SdkCallOptions): Promise; /** * Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway. */ describeDirectConnectGatewayAssociationProposals(input: AWS.DirectConnect.DescribeDirectConnectGatewayAssociationProposalsRequest, options: SdkCallOptions): Promise; /** * Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following: A Direct Connect gateway The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway. A virtual private gateway The response contains the Direct Connect gateway. A transit gateway The response contains the Direct Connect gateway. A Direct Connect gateway and a virtual private gateway The response contains the association between the Direct Connect gateway and virtual private gateway. A Direct Connect gateway and a transit gateway The response contains the association between the Direct Connect gateway and transit gateway. */ describeDirectConnectGatewayAssociations(input: AWS.DirectConnect.DescribeDirectConnectGatewayAssociationsRequest, options: SdkCallOptions): Promise; /** * Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface. */ describeDirectConnectGatewayAttachments(input: AWS.DirectConnect.DescribeDirectConnectGatewayAttachmentsRequest, options: SdkCallOptions): Promise; /** * Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned. */ describeDirectConnectGateways(input: AWS.DirectConnect.DescribeDirectConnectGatewaysRequest, options: SdkCallOptions): Promise; /** * Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG). Intended for use by Direct Connect Partners only. */ describeHostedConnections(input: AWS.DirectConnect.DescribeHostedConnectionsRequest, options: SdkCallOptions): Promise; /** * Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for the specified interconnect. The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide. */ describeInterconnectLoa(input: AWS.DirectConnect.DescribeInterconnectLoaRequest, options: SdkCallOptions): Promise; /** * Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect. */ describeInterconnects(input: AWS.DirectConnect.DescribeInterconnectsRequest, options: SdkCallOptions): Promise; /** * Describes all your link aggregation groups (LAG) or the specified LAG. */ describeLags(input: AWS.DirectConnect.DescribeLagsRequest, options: SdkCallOptions): Promise; /** * Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG). The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide. */ describeLoa(input: AWS.DirectConnect.DescribeLoaRequest, options: SdkCallOptions): Promise; /** * Details about the router. */ describeRouterConfiguration(input: AWS.DirectConnect.DescribeRouterConfigurationRequest, options: SdkCallOptions): Promise; /** * Describes the tags associated with the specified Direct Connect resources. */ describeTags(input: AWS.DirectConnect.DescribeTagsRequest, options: SdkCallOptions): Promise; /** * Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned. A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network. */ describeVirtualInterfaces(input: AWS.DirectConnect.DescribeVirtualInterfacesRequest, options: SdkCallOptions): Promise; /** * Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect. If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections. */ disassociateConnectionFromLag(input: AWS.DirectConnect.DisassociateConnectionFromLagRequest, options: SdkCallOptions): Promise; /** * Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection. */ disassociateMacSecKey(input: AWS.DirectConnect.DisassociateMacSecKeyRequest, options: SdkCallOptions): Promise; /** * Lists the virtual interface failover test history. */ listVirtualInterfaceTestHistory(input: AWS.DirectConnect.ListVirtualInterfaceTestHistoryRequest, options: SdkCallOptions): Promise; /** * Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages. You can run the test on public, private, transit, and hosted virtual interfaces. You can use ListVirtualInterfaceTestHistory to view the virtual interface test history. If you need to stop the test before the test interval completes, use StopBgpFailoverTest. */ startBgpFailoverTest(input: AWS.DirectConnect.StartBgpFailoverTestRequest, options: SdkCallOptions): Promise; /** * Stops the virtual interface failover test. */ stopBgpFailoverTest(input: AWS.DirectConnect.StopBgpFailoverTestRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value. */ tagResource(input: AWS.DirectConnect.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified Direct Connect resource. */ untagResource(input: AWS.DirectConnect.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the Direct Connect dedicated connection configuration. You can update the following parameters for a connection: The connection name The connection's MAC Security (MACsec) encryption mode. */ updateConnection(input: AWS.DirectConnect.UpdateConnectionRequest, options: SdkCallOptions): Promise; /** * Updates the name of a current Direct Connect gateway. */ updateDirectConnectGateway(input: AWS.DirectConnect.UpdateDirectConnectGatewayRequest, options: SdkCallOptions): Promise; /** * Updates the specified attributes of the Direct Connect gateway association. Add or remove prefixes from the association. */ updateDirectConnectGatewayAssociation(input: AWS.DirectConnect.UpdateDirectConnectGatewayAssociationRequest, options: SdkCallOptions): Promise; /** * Updates the attributes of the specified link aggregation group (LAG). You can update the following LAG attributes: The name of the LAG. The value for the minimum number of connections that must be operational for the LAG itself to be operational. The LAG's MACsec encryption mode. Amazon Web Services assigns this value to each connection which is part of the LAG. The tags If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational. */ updateLag(input: AWS.DirectConnect.UpdateLagRequest, options: SdkCallOptions): Promise; /** * Updates the specified attributes of the specified virtual private interface. Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual q interface supports jumbo frames, call DescribeVirtualInterfaces. */ updateVirtualInterfaceAttributes(input: AWS.DirectConnect.UpdateVirtualInterfaceAttributesRequest, options: SdkCallOptions): Promise; } export interface DirectoryService { /** * Accepts a directory sharing request that was sent from the directory owner account. */ acceptSharedDirectory(input: AWS.DirectoryService.AcceptSharedDirectoryRequest, options: SdkCallOptions): Promise; /** * If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC. Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference. */ addIpRoutes(input: AWS.DirectoryService.AddIpRoutesRequest, options: SdkCallOptions): Promise; /** * Adds two domain controllers in the specified Region for the specified directory. */ addRegion(input: AWS.DirectoryService.AddRegionRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource. */ addTagsToResource(input: AWS.DirectoryService.AddTagsToResourceRequest, options: SdkCallOptions): Promise; /** * Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema. */ cancelSchemaExtension(input: AWS.DirectoryService.CancelSchemaExtensionRequest, options: SdkCallOptions): Promise; /** * Creates an AD Connector to connect to a self-managed directory. Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference. */ connectDirectory(input: AWS.DirectoryService.ConnectDirectoryRequest, options: SdkCallOptions): Promise; /** * Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. */ createAlias(input: AWS.DirectoryService.CreateAliasRequest, options: SdkCallOptions): Promise; /** * Creates an Active Directory computer object in the specified directory. */ createComputer(input: AWS.DirectoryService.CreateComputerRequest, options: SdkCallOptions): Promise; /** * Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain. */ createConditionalForwarder(input: AWS.DirectoryService.CreateConditionalForwarderRequest, options: SdkCallOptions): Promise; /** * Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide. Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference. */ createDirectory(input: AWS.DirectoryService.CreateDirectoryRequest, options: SdkCallOptions): Promise; /** * Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account. */ createLogSubscription(input: AWS.DirectoryService.CreateLogSubscriptionRequest, options: SdkCallOptions): Promise; /** * Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide. Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference. */ createMicrosoftAD(input: AWS.DirectoryService.CreateMicrosoftADRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud. You cannot take snapshots of AD Connector directories. */ createSnapshot(input: AWS.DirectoryService.CreateSnapshotRequest, options: SdkCallOptions): Promise; /** * Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust. */ createTrust(input: AWS.DirectoryService.CreateTrustRequest, options: SdkCallOptions): Promise; /** * Deletes a conditional forwarder that has been set up for your Amazon Web Services directory. */ deleteConditionalForwarder(input: AWS.DirectoryService.DeleteConditionalForwarderRequest, options: SdkCallOptions): Promise; /** * Deletes an Directory Service directory. Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference. */ deleteDirectory(input: AWS.DirectoryService.DeleteDirectoryRequest, options: SdkCallOptions): Promise; /** * Deletes the specified log subscription. */ deleteLogSubscription(input: AWS.DirectoryService.DeleteLogSubscriptionRequest, options: SdkCallOptions): Promise; /** * Deletes a directory snapshot. */ deleteSnapshot(input: AWS.DirectoryService.DeleteSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain. */ deleteTrust(input: AWS.DirectoryService.DeleteTrustRequest, options: SdkCallOptions): Promise; /** * Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication. */ deregisterCertificate(input: AWS.DirectoryService.DeregisterCertificateRequest, options: SdkCallOptions): Promise; /** * Removes the specified directory as a publisher to the specified Amazon SNS topic. */ deregisterEventTopic(input: AWS.DirectoryService.DeregisterEventTopicRequest, options: SdkCallOptions): Promise; /** * Displays information about the certificate registered for secure LDAP or client certificate authentication. */ describeCertificate(input: AWS.DirectoryService.DescribeCertificateRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported. */ describeClientAuthenticationSettings(input: AWS.DirectoryService.DescribeClientAuthenticationSettingsRequest, options: SdkCallOptions): Promise; /** * Obtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID. */ describeConditionalForwarders(input: AWS.DirectoryService.DescribeConditionalForwardersRequest, options: SdkCallOptions): Promise; /** * Obtains information about the directories that belong to this account. You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter. */ describeDirectories(input: AWS.DirectoryService.DescribeDirectoriesRequest, options: SdkCallOptions): Promise; /** * Provides information about any domain controllers in your directory. */ describeDomainControllers(input: AWS.DirectoryService.DescribeDomainControllersRequest, options: SdkCallOptions): Promise; /** * Obtains information about which Amazon SNS topics receive status messages from the specified directory. If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. */ describeEventTopics(input: AWS.DirectoryService.DescribeEventTopicsRequest, options: SdkCallOptions): Promise; /** * Describes the status of LDAP security for the specified directory. */ describeLDAPSSettings(input: AWS.DirectoryService.DescribeLDAPSSettingsRequest, options: SdkCallOptions): Promise; /** * Provides information about the Regions that are configured for multi-Region replication. */ describeRegions(input: AWS.DirectoryService.DescribeRegionsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the configurable settings for the specified directory. */ describeSettings(input: AWS.DirectoryService.DescribeSettingsRequest, options: SdkCallOptions): Promise; /** * Returns the shared directories in your account. */ describeSharedDirectories(input: AWS.DirectoryService.DescribeSharedDirectoriesRequest, options: SdkCallOptions): Promise; /** * Obtains information about the directory snapshots that belong to this account. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter. */ describeSnapshots(input: AWS.DirectoryService.DescribeSnapshotsRequest, options: SdkCallOptions): Promise; /** * Obtains information about the trust relationships for this account. If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. */ describeTrusts(input: AWS.DirectoryService.DescribeTrustsRequest, options: SdkCallOptions): Promise; /** * Disables alternative client authentication methods for the specified directory. */ disableClientAuthentication(input: AWS.DirectoryService.DisableClientAuthenticationRequest, options: SdkCallOptions): Promise; /** * Deactivates LDAP secure calls for the specified directory. */ disableLDAPS(input: AWS.DirectoryService.DisableLDAPSRequest, options: SdkCallOptions): Promise; /** * Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. */ disableRadius(input: AWS.DirectoryService.DisableRadiusRequest, options: SdkCallOptions): Promise; /** * Disables single-sign on for a directory. */ disableSso(input: AWS.DirectoryService.DisableSsoRequest, options: SdkCallOptions): Promise; /** * Enables alternative client authentication methods for the specified directory. */ enableClientAuthentication(input: AWS.DirectoryService.EnableClientAuthenticationRequest, options: SdkCallOptions): Promise; /** * Activates the switch for the specific directory to always use LDAP secure calls. */ enableLDAPS(input: AWS.DirectoryService.EnableLDAPSRequest, options: SdkCallOptions): Promise; /** * Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. */ enableRadius(input: AWS.DirectoryService.EnableRadiusRequest, options: SdkCallOptions): Promise; /** * Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately. */ enableSso(input: AWS.DirectoryService.EnableSsoRequest, options: SdkCallOptions): Promise; /** * Obtains directory limit information for the current Region. */ getDirectoryLimits(input: AWS.DirectoryService.GetDirectoryLimitsRequest, options: SdkCallOptions): Promise; /** * Obtains the manual snapshot limits for a directory. */ getSnapshotLimits(input: AWS.DirectoryService.GetSnapshotLimitsRequest, options: SdkCallOptions): Promise; /** * For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication. */ listCertificates(input: AWS.DirectoryService.ListCertificatesRequest, options: SdkCallOptions): Promise; /** * Lists the address blocks that you have added to a directory. */ listIpRoutes(input: AWS.DirectoryService.ListIpRoutesRequest, options: SdkCallOptions): Promise; /** * Lists the active log subscriptions for the Amazon Web Services account. */ listLogSubscriptions(input: AWS.DirectoryService.ListLogSubscriptionsRequest, options: SdkCallOptions): Promise; /** * Lists all schema extensions applied to a Microsoft AD Directory. */ listSchemaExtensions(input: AWS.DirectoryService.ListSchemaExtensionsRequest, options: SdkCallOptions): Promise; /** * Lists all tags on a directory. */ listTagsForResource(input: AWS.DirectoryService.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Registers a certificate for a secure LDAP or client certificate authentication. */ registerCertificate(input: AWS.DirectoryService.RegisterCertificateRequest, options: SdkCallOptions): Promise; /** * Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. */ registerEventTopic(input: AWS.DirectoryService.RegisterEventTopicRequest, options: SdkCallOptions): Promise; /** * Rejects a directory sharing request that was sent from the directory owner account. */ rejectSharedDirectory(input: AWS.DirectoryService.RejectSharedDirectoryRequest, options: SdkCallOptions): Promise; /** * Removes IP address blocks from a directory. */ removeIpRoutes(input: AWS.DirectoryService.RemoveIpRoutesRequest, options: SdkCallOptions): Promise; /** * Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the DeleteDirectory API. */ removeRegion(input: AWS.DirectoryService.RemoveRegionRequest, options: SdkCallOptions): Promise; /** * Removes tags from a directory. */ removeTagsFromResource(input: AWS.DirectoryService.RemoveTagsFromResourceRequest, options: SdkCallOptions): Promise; /** * Resets the password for any user in your Managed Microsoft AD or Simple AD directory. You can reset the password for any user in your directory with the following exceptions: For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user. For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide. */ resetUserPassword(input: AWS.DirectoryService.ResetUserPasswordRequest, options: SdkCallOptions): Promise; /** * Restores a directory using an existing directory snapshot. When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete. */ restoreFromSnapshot(input: AWS.DirectoryService.RestoreFromSnapshotRequest, options: SdkCallOptions): Promise; /** * Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region. When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account. The ShareMethod parameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization (HANDSHAKE). The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer. */ shareDirectory(input: AWS.DirectoryService.ShareDirectoryRequest, options: SdkCallOptions): Promise; /** * Applies a schema extension to a Microsoft AD directory. */ startSchemaExtension(input: AWS.DirectoryService.StartSchemaExtensionRequest, options: SdkCallOptions): Promise; /** * Stops the directory sharing between the directory owner and consumer accounts. */ unshareDirectory(input: AWS.DirectoryService.UnshareDirectoryRequest, options: SdkCallOptions): Promise; /** * Updates a conditional forwarder that has been set up for your Amazon Web Services directory. */ updateConditionalForwarder(input: AWS.DirectoryService.UpdateConditionalForwarderRequest, options: SdkCallOptions): Promise; /** * Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request. */ updateNumberOfDomainControllers(input: AWS.DirectoryService.UpdateNumberOfDomainControllersRequest, options: SdkCallOptions): Promise; /** * Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory. */ updateRadius(input: AWS.DirectoryService.UpdateRadiusRequest, options: SdkCallOptions): Promise; /** * Updates the configurable settings for the specified directory. */ updateSettings(input: AWS.DirectoryService.UpdateSettingsRequest, options: SdkCallOptions): Promise; /** * Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory. */ updateTrust(input: AWS.DirectoryService.UpdateTrustRequest, options: SdkCallOptions): Promise; /** * Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain. */ verifyTrust(input: AWS.DirectoryService.VerifyTrustRequest, options: SdkCallOptions): Promise; } export interface Discovery { /** * Associates one or more configuration items with an application. */ associateConfigurationItemsToApplication(input: AWS.Discovery.AssociateConfigurationItemsToApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications. Amazon Web Services Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted. */ batchDeleteImportData(input: AWS.Discovery.BatchDeleteImportDataRequest, options: SdkCallOptions): Promise; /** * Creates an application with the given name and description. */ createApplication(input: AWS.Discovery.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items. Do not store sensitive information (like personal data) in tags. */ createTags(input: AWS.Discovery.CreateTagsRequest, options: SdkCallOptions): Promise; /** * Deletes a list of applications and their associations with configuration items. */ deleteApplications(input: AWS.Discovery.DeleteApplicationsRequest, options: SdkCallOptions): Promise; /** * Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items. */ deleteTags(input: AWS.Discovery.DeleteTagsRequest, options: SdkCallOptions): Promise; /** * Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters. */ describeAgents(input: AWS.Discovery.DescribeAgentsRequest, options: SdkCallOptions): Promise; /** * Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type from one of the following: server application process connection Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc. For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application Discovery Service User Guide. */ describeConfigurations(input: AWS.Discovery.DescribeConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters. */ describeContinuousExports(input: AWS.Discovery.DescribeContinuousExportsRequest, options: SdkCallOptions): Promise; /** * DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead. */ describeExportConfigurations(input: AWS.Discovery.DescribeExportConfigurationsRequest, options: SdkCallOptions): Promise; /** * Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks. */ describeExportTasks(input: AWS.Discovery.DescribeExportTasksRequest, options: SdkCallOptions): Promise; /** * Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more. */ describeImportTasks(input: AWS.Discovery.DescribeImportTasksRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters. There are three valid tag filter names: tagKey tagValue configurationId Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters. */ describeTags(input: AWS.Discovery.DescribeTagsRequest, options: SdkCallOptions): Promise; /** * Disassociates one or more configuration items from an application. */ disassociateConfigurationItemsFromApplication(input: AWS.Discovery.DisassociateConfigurationItemsFromApplicationRequest, options: SdkCallOptions): Promise; /** * Retrieves a short summary of discovered assets. This API operation takes no request parameters and is called as is at the command prompt as shown in the example. */ getDiscoverySummary(input: AWS.Discovery.GetDiscoverySummaryRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results. */ listConfigurations(input: AWS.Discovery.ListConfigurationsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of servers that are one network hop away from a specified server. */ listServerNeighbors(input: AWS.Discovery.ListServerNeighborsRequest, options: SdkCallOptions): Promise; /** * Start the continuous flow of agent's discovered data into Amazon Athena. */ startContinuousExport(input: AWS.Discovery.StartContinuousExportRequest, options: SdkCallOptions): Promise; /** * Instructs the specified agents or connectors to start collecting data. */ startDataCollectionByAgentIds(input: AWS.Discovery.StartDataCollectionByAgentIdsRequest, options: SdkCallOptions): Promise; /** * Begins the export of discovered data to an S3 bucket. If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports. If you do not include an agentIds filter, summary data is exported that includes both Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery Agents. Export of summary data is limited to two exports per day. */ startExportTask(input: AWS.Discovery.StartExportTaskRequest, options: SdkCallOptions): Promise; /** * Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status. To start an import request, do this: Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv. Fill out the template with your server and application data. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format. Use the console or the StartImportTask command with the Amazon Web Services CLI or one of the Amazon Web Services SDKs to import the records from your file. For more information, including step-by-step procedures, see Migration Hub Import in the Amazon Web Services Application Discovery Service User Guide. There are limits to the number of import tasks you can create (and delete) in an Amazon Web Services account. For more information, see Amazon Web Services Application Discovery Service Limits in the Amazon Web Services Application Discovery Service User Guide. */ startImportTask(input: AWS.Discovery.StartImportTaskRequest, options: SdkCallOptions): Promise; /** * Stop the continuous flow of agent's discovered data into Amazon Athena. */ stopContinuousExport(input: AWS.Discovery.StopContinuousExportRequest, options: SdkCallOptions): Promise; /** * Instructs the specified agents or connectors to stop collecting data. */ stopDataCollectionByAgentIds(input: AWS.Discovery.StopDataCollectionByAgentIdsRequest, options: SdkCallOptions): Promise; /** * Updates metadata about an application. */ updateApplication(input: AWS.Discovery.UpdateApplicationRequest, options: SdkCallOptions): Promise; } export interface DLM { /** * Creates a policy to manage the lifecycle of the specified Amazon Web Services resources. You can create up to 100 lifecycle policies. */ createLifecyclePolicy(input: AWS.DLM.CreateLifecyclePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes the specified lifecycle policy and halts the automated operations that the policy specified. For more information about deleting a policy, see Delete lifecycle policies. */ deleteLifecyclePolicy(input: AWS.DLM.DeleteLifecyclePolicyRequest, options: SdkCallOptions): Promise; /** * Gets summary information about all or the specified data lifecycle policies. To get complete information about a policy, use GetLifecyclePolicy. */ getLifecyclePolicies(input: AWS.DLM.GetLifecyclePoliciesRequest, options: SdkCallOptions): Promise; /** * Gets detailed information about the specified lifecycle policy. */ getLifecyclePolicy(input: AWS.DLM.GetLifecyclePolicyRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.DLM.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified resource. */ tagResource(input: AWS.DLM.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified resource. */ untagResource(input: AWS.DLM.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified lifecycle policy. For more information about updating a policy, see Modify lifecycle policies. */ updateLifecyclePolicy(input: AWS.DLM.UpdateLifecyclePolicyRequest, options: SdkCallOptions): Promise; } export interface DMS { /** * Adds metadata tags to an DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see Tag data type description. */ addTagsToResource(input: AWS.DMS.AddTagsToResourceMessage, options: SdkCallOptions): Promise; /** * Applies a pending maintenance action to a resource (for example, to a replication instance). */ applyPendingMaintenanceAction(input: AWS.DMS.ApplyPendingMaintenanceActionMessage, options: SdkCallOptions): Promise; /** * Cancels a single premigration assessment run. This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running. */ cancelReplicationTaskAssessmentRun(input: AWS.DMS.CancelReplicationTaskAssessmentRunMessage, options: SdkCallOptions): Promise; /** * Creates an endpoint using the provided settings. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. */ createEndpoint(input: AWS.DMS.CreateEndpointMessage, options: SdkCallOptions): Promise; /** * Creates an DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account. For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide. */ createEventSubscription(input: AWS.DMS.CreateEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Creates a Fleet Advisor collector using the specified parameters. */ createFleetAdvisorCollector(input: AWS.DMS.CreateFleetAdvisorCollectorRequest, options: SdkCallOptions): Promise; /** * Creates the replication instance using the specified parameters. DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS. */ createReplicationInstance(input: AWS.DMS.CreateReplicationInstanceMessage, options: SdkCallOptions): Promise; /** * Creates a replication subnet group given a list of the subnet IDs in a VPC. The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception. */ createReplicationSubnetGroup(input: AWS.DMS.CreateReplicationSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Creates a replication task using the specified parameters. */ createReplicationTask(input: AWS.DMS.CreateReplicationTaskMessage, options: SdkCallOptions): Promise; /** * Deletes the specified certificate. */ deleteCertificate(input: AWS.DMS.DeleteCertificateMessage, options: SdkCallOptions): Promise; /** * Deletes the connection between a replication instance and an endpoint. */ deleteConnection(input: AWS.DMS.DeleteConnectionMessage, options: SdkCallOptions): Promise; /** * Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint. */ deleteEndpoint(input: AWS.DMS.DeleteEndpointMessage, options: SdkCallOptions): Promise; /** * Deletes an DMS event subscription. */ deleteEventSubscription(input: AWS.DMS.DeleteEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Deletes the specified Fleet Advisor collector. */ deleteFleetAdvisorCollector(input: AWS.DMS.DeleteCollectorRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Fleet Advisor collector databases. */ deleteFleetAdvisorDatabases(input: AWS.DMS.DeleteFleetAdvisorDatabasesRequest, options: SdkCallOptions): Promise; /** * Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it. */ deleteReplicationInstance(input: AWS.DMS.DeleteReplicationInstanceMessage, options: SdkCallOptions): Promise; /** * Deletes a subnet group. */ deleteReplicationSubnetGroup(input: AWS.DMS.DeleteReplicationSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Deletes the specified replication task. */ deleteReplicationTask(input: AWS.DMS.DeleteReplicationTaskMessage, options: SdkCallOptions): Promise; /** * Deletes the record of a single premigration assessment run. This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket. */ deleteReplicationTaskAssessmentRun(input: AWS.DMS.DeleteReplicationTaskAssessmentRunMessage, options: SdkCallOptions): Promise; /** * Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region. This command does not take any parameters. */ describeAccountAttributes(input: AWS.DMS.DescribeAccountAttributesMessage, options: SdkCallOptions): Promise; /** * Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters. If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run. To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task. If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task. */ describeApplicableIndividualAssessments(input: AWS.DMS.DescribeApplicableIndividualAssessmentsMessage, options: SdkCallOptions): Promise; /** * Provides a description of the certificate. */ describeCertificates(input: AWS.DMS.DescribeCertificatesMessage, options: SdkCallOptions): Promise; /** * Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint. */ describeConnections(input: AWS.DMS.DescribeConnectionsMessage, options: SdkCallOptions): Promise; /** * Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine. */ describeEndpointSettings(input: AWS.DMS.DescribeEndpointSettingsMessage, options: SdkCallOptions): Promise; /** * Returns information about the type of endpoints available. */ describeEndpointTypes(input: AWS.DMS.DescribeEndpointTypesMessage, options: SdkCallOptions): Promise; /** * Returns information about the endpoints for your account in the current region. */ describeEndpoints(input: AWS.DMS.DescribeEndpointsMessage, options: SdkCallOptions): Promise; /** * Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the Database Migration Service User Guide. */ describeEventCategories(input: AWS.DMS.DescribeEventCategoriesMessage, options: SdkCallOptions): Promise; /** * Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify SubscriptionName, this action lists the description for that subscription. */ describeEventSubscriptions(input: AWS.DMS.DescribeEventSubscriptionsMessage, options: SdkCallOptions): Promise; /** * Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide. */ describeEvents(input: AWS.DMS.DescribeEventsMessage, options: SdkCallOptions): Promise; /** * Returns a list of the Fleet Advisor collectors in your account. */ describeFleetAdvisorCollectors(input: AWS.DMS.DescribeFleetAdvisorCollectorsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Fleet Advisor databases in your account. */ describeFleetAdvisorDatabases(input: AWS.DMS.DescribeFleetAdvisorDatabasesRequest, options: SdkCallOptions): Promise; /** * Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors. */ describeFleetAdvisorLsaAnalysis(input: AWS.DMS.DescribeFleetAdvisorLsaAnalysisRequest, options: SdkCallOptions): Promise; /** * Provides descriptions of the schemas discovered by your Fleet Advisor collectors. */ describeFleetAdvisorSchemaObjectSummary(input: AWS.DMS.DescribeFleetAdvisorSchemaObjectSummaryRequest, options: SdkCallOptions): Promise; /** * Returns a list of schemas detected by Fleet Advisor Collectors in your account. */ describeFleetAdvisorSchemas(input: AWS.DMS.DescribeFleetAdvisorSchemasRequest, options: SdkCallOptions): Promise; /** * Returns information about the replication instance types that can be created in the specified region. */ describeOrderableReplicationInstances(input: AWS.DMS.DescribeOrderableReplicationInstancesMessage, options: SdkCallOptions): Promise; /** * For internal use only */ describePendingMaintenanceActions(input: AWS.DMS.DescribePendingMaintenanceActionsMessage, options: SdkCallOptions): Promise; /** * Returns the status of the RefreshSchemas operation. */ describeRefreshSchemasStatus(input: AWS.DMS.DescribeRefreshSchemasStatusMessage, options: SdkCallOptions): Promise; /** * Returns information about the task logs for the specified task. */ describeReplicationInstanceTaskLogs(input: AWS.DMS.DescribeReplicationInstanceTaskLogsMessage, options: SdkCallOptions): Promise; /** * Returns information about replication instances for your account in the current region. */ describeReplicationInstances(input: AWS.DMS.DescribeReplicationInstancesMessage, options: SdkCallOptions): Promise; /** * Returns information about the replication subnet groups. */ describeReplicationSubnetGroups(input: AWS.DMS.DescribeReplicationSubnetGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results. For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide. */ describeReplicationTaskAssessmentResults(input: AWS.DMS.DescribeReplicationTaskAssessmentResultsMessage, options: SdkCallOptions): Promise; /** * Returns a paginated list of premigration assessment runs based on filter settings. These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values. This operation doesn't return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation. */ describeReplicationTaskAssessmentRuns(input: AWS.DMS.DescribeReplicationTaskAssessmentRunsMessage, options: SdkCallOptions): Promise; /** * Returns a paginated list of individual assessments based on filter settings. These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values. */ describeReplicationTaskIndividualAssessments(input: AWS.DMS.DescribeReplicationTaskIndividualAssessmentsMessage, options: SdkCallOptions): Promise; /** * Returns information about replication tasks for your account in the current region. */ describeReplicationTasks(input: AWS.DMS.DescribeReplicationTasksMessage, options: SdkCallOptions): Promise; /** * Returns information about the schema for the specified endpoint. */ describeSchemas(input: AWS.DMS.DescribeSchemasMessage, options: SdkCallOptions): Promise; /** * Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table. */ describeTableStatistics(input: AWS.DMS.DescribeTableStatisticsMessage, options: SdkCallOptions): Promise; /** * Uploads the specified certificate. */ importCertificate(input: AWS.DMS.ImportCertificateMessage, options: SdkCallOptions): Promise; /** * Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description. */ listTagsForResource(input: AWS.DMS.ListTagsForResourceMessage, options: SdkCallOptions): Promise; /** * Modifies the specified endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. */ modifyEndpoint(input: AWS.DMS.ModifyEndpointMessage, options: SdkCallOptions): Promise; /** * Modifies an existing DMS event notification subscription. */ modifyEventSubscription(input: AWS.DMS.ModifyEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window. */ modifyReplicationInstance(input: AWS.DMS.ModifyReplicationInstanceMessage, options: SdkCallOptions): Promise; /** * Modifies the settings for the specified replication subnet group. */ modifyReplicationSubnetGroup(input: AWS.DMS.ModifyReplicationSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide. */ modifyReplicationTask(input: AWS.DMS.ModifyReplicationTaskMessage, options: SdkCallOptions): Promise; /** * Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance. */ moveReplicationTask(input: AWS.DMS.MoveReplicationTaskMessage, options: SdkCallOptions): Promise; /** * Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again. */ rebootReplicationInstance(input: AWS.DMS.RebootReplicationInstanceMessage, options: SdkCallOptions): Promise; /** * Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation. */ refreshSchemas(input: AWS.DMS.RefreshSchemasMessage, options: SdkCallOptions): Promise; /** * Reloads the target database table with the source data. You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception. */ reloadTables(input: AWS.DMS.ReloadTablesMessage, options: SdkCallOptions): Promise; /** * Removes metadata tags from an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description. */ removeTagsFromResource(input: AWS.DMS.RemoveTagsFromResourceMessage, options: SdkCallOptions): Promise; /** * Starts the replication task. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide. */ startReplicationTask(input: AWS.DMS.StartReplicationTaskMessage, options: SdkCallOptions): Promise; /** * Starts the replication task assessment for unsupported data types in the source database. You can only use this operation for a task if the following conditions are true: The task must be in the stopped state. The task must have successful connections to the source and target. If either of these conditions are not met, an InvalidResourceStateFault error will result. For information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide. */ startReplicationTaskAssessment(input: AWS.DMS.StartReplicationTaskAssessmentMessage, options: SdkCallOptions): Promise; /** * Starts a new premigration assessment run for one or more individual assessments of a migration task. The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete. */ startReplicationTaskAssessmentRun(input: AWS.DMS.StartReplicationTaskAssessmentRunMessage, options: SdkCallOptions): Promise; /** * Stops the replication task. */ stopReplicationTask(input: AWS.DMS.StopReplicationTaskMessage, options: SdkCallOptions): Promise; /** * Tests the connection between the replication instance and the endpoint. */ testConnection(input: AWS.DMS.TestConnectionMessage, options: SdkCallOptions): Promise; /** * Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher. If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the Force option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be available when you use Amazon EventBridge. To call this operation, make sure that you have certain permissions added to your user account. For more information, see Migrating event subscriptions to Amazon EventBridge in the Amazon Web Services Database Migration Service User Guide. */ updateSubscriptionsToEventBridge(input: AWS.DMS.UpdateSubscriptionsToEventBridgeMessage, options: SdkCallOptions): Promise; } export interface DocDB { /** * Adds a source identifier to an existing event notification subscription. */ addSourceIdentifierToSubscription(input: AWS.DocDB.AddSourceIdentifierToSubscriptionMessage, options: SdkCallOptions): Promise; /** * Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB. */ addTagsToResource(input: AWS.DocDB.AddTagsToResourceMessage, options: SdkCallOptions): Promise<{}>; /** * Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance). */ applyPendingMaintenanceAction(input: AWS.DocDB.ApplyPendingMaintenanceActionMessage, options: SdkCallOptions): Promise; /** * Copies the specified cluster parameter group. */ copyDBClusterParameterGroup(input: AWS.DocDB.CopyDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region. To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status. */ copyDBClusterSnapshot(input: AWS.DocDB.CopyDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Creates a new Amazon DocumentDB cluster. */ createDBCluster(input: AWS.DocDB.CreateDBClusterMessage, options: SdkCallOptions): Promise; /** * Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups. */ createDBClusterParameterGroup(input: AWS.DocDB.CreateDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a snapshot of a cluster. */ createDBClusterSnapshot(input: AWS.DocDB.CreateDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Creates a new instance. */ createDBInstance(input: AWS.DocDB.CreateDBInstanceMessage, options: SdkCallOptions): Promise; /** * Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region. */ createDBSubnetGroup(input: AWS.DocDB.CreateDBSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console. You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account. */ createEventSubscription(input: AWS.DocDB.CreateEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance. You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster. This action only applies to Amazon DocumentDB clusters. */ createGlobalCluster(input: AWS.DocDB.CreateGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted. */ deleteDBCluster(input: AWS.DocDB.DeleteDBClusterMessage, options: SdkCallOptions): Promise; /** * Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters. */ deleteDBClusterParameterGroup(input: AWS.DocDB.DeleteDBClusterParameterGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The cluster snapshot must be in the available state to be deleted. */ deleteDBClusterSnapshot(input: AWS.DocDB.DeleteDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Deletes a previously provisioned instance. */ deleteDBInstance(input: AWS.DocDB.DeleteDBInstanceMessage, options: SdkCallOptions): Promise; /** * Deletes a subnet group. The specified database subnet group must not be associated with any DB instances. */ deleteDBSubnetGroup(input: AWS.DocDB.DeleteDBSubnetGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes an Amazon DocumentDB event notification subscription. */ deleteEventSubscription(input: AWS.DocDB.DeleteEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster. This action only applies to Amazon DocumentDB clusters. */ deleteGlobalCluster(input: AWS.DocDB.DeleteGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account. */ describeCertificates(input: AWS.DocDB.DescribeCertificatesMessage, options: SdkCallOptions): Promise; /** * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group. */ describeDBClusterParameterGroups(input: AWS.DocDB.DescribeDBClusterParameterGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the detailed parameter list for a particular cluster parameter group. */ describeDBClusterParameters(input: AWS.DocDB.DescribeDBClusterParametersMessage, options: SdkCallOptions): Promise; /** * Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts. */ describeDBClusterSnapshotAttributes(input: AWS.DocDB.DescribeDBClusterSnapshotAttributesMessage, options: SdkCallOptions): Promise; /** * Returns information about cluster snapshots. This API operation supports pagination. */ describeDBClusterSnapshots(input: AWS.DocDB.DescribeDBClusterSnapshotsMessage, options: SdkCallOptions): Promise; /** * Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters. */ describeDBClusters(input: AWS.DocDB.DescribeDBClustersMessage, options: SdkCallOptions): Promise; /** * Returns a list of the available engines. */ describeDBEngineVersions(input: AWS.DocDB.DescribeDBEngineVersionsMessage, options: SdkCallOptions): Promise; /** * Returns information about provisioned Amazon DocumentDB instances. This API supports pagination. */ describeDBInstances(input: AWS.DocDB.DescribeDBInstancesMessage, options: SdkCallOptions): Promise; /** * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. */ describeDBSubnetGroups(input: AWS.DocDB.DescribeDBSubnetGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the default engine and system parameter information for the cluster database engine. */ describeEngineDefaultClusterParameters(input: AWS.DocDB.DescribeEngineDefaultClusterParametersMessage, options: SdkCallOptions): Promise; /** * Displays a list of categories for all event source types, or, if specified, for a specified source type. */ describeEventCategories(input: AWS.DocDB.DescribeEventCategoriesMessage, options: SdkCallOptions): Promise; /** * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. */ describeEventSubscriptions(input: AWS.DocDB.DescribeEventSubscriptionsMessage, options: SdkCallOptions): Promise; /** * Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned. */ describeEvents(input: AWS.DocDB.DescribeEventsMessage, options: SdkCallOptions): Promise; /** * Returns information about Amazon DocumentDB global clusters. This API supports pagination. This action only applies to Amazon DocumentDB clusters. */ describeGlobalClusters(input: AWS.DocDB.DescribeGlobalClustersMessage, options: SdkCallOptions): Promise; /** * Returns a list of orderable instance options for the specified engine. */ describeOrderableDBInstanceOptions(input: AWS.DocDB.DescribeOrderableDBInstanceOptionsMessage, options: SdkCallOptions): Promise; /** * Returns a list of resources (for example, instances) that have at least one pending maintenance action. */ describePendingMaintenanceActions(input: AWS.DocDB.DescribePendingMaintenanceActionsMessage, options: SdkCallOptions): Promise; /** * Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing. */ failoverDBCluster(input: AWS.DocDB.FailoverDBClusterMessage, options: SdkCallOptions): Promise; /** * Lists all tags on an Amazon DocumentDB resource. */ listTagsForResource(input: AWS.DocDB.ListTagsForResourceMessage, options: SdkCallOptions): Promise; /** * Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. */ modifyDBCluster(input: AWS.DocDB.ModifyDBClusterMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect. After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter. */ modifyDBClusterParameterGroup(input: AWS.DocDB.ModifyDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot. To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. */ modifyDBClusterSnapshotAttribute(input: AWS.DocDB.ModifyDBClusterSnapshotAttributeMessage, options: SdkCallOptions): Promise; /** * Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. */ modifyDBInstance(input: AWS.DocDB.ModifyDBInstanceMessage, options: SdkCallOptions): Promise; /** * Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region. */ modifyDBSubnetGroup(input: AWS.DocDB.ModifyDBSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Modifies an existing Amazon DocumentDB event notification subscription. */ modifyEventSubscription(input: AWS.DocDB.ModifyEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request. This action only applies to Amazon DocumentDB clusters. */ modifyGlobalCluster(input: AWS.DocDB.ModifyGlobalClusterMessage, options: SdkCallOptions): Promise; /** * You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting. */ rebootDBInstance(input: AWS.DocDB.RebootDBInstanceMessage, options: SdkCallOptions): Promise; /** * Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region. This action only applies to Amazon DocumentDB clusters. */ removeFromGlobalCluster(input: AWS.DocDB.RemoveFromGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Removes a source identifier from an existing Amazon DocumentDB event notification subscription. */ removeSourceIdentifierFromSubscription(input: AWS.DocDB.RemoveSourceIdentifierFromSubscriptionMessage, options: SdkCallOptions): Promise; /** * Removes metadata tags from an Amazon DocumentDB resource. */ removeTagsFromResource(input: AWS.DocDB.RemoveTagsFromResourceMessage, options: SdkCallOptions): Promise<{}>; /** * Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot. */ resetDBClusterParameterGroup(input: AWS.DocDB.ResetDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group. If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group. */ restoreDBClusterFromSnapshot(input: AWS.DocDB.RestoreDBClusterFromSnapshotMessage, options: SdkCallOptions): Promise; /** * Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group. */ restoreDBClusterToPointInTime(input: AWS.DocDB.RestoreDBClusterToPointInTimeMessage, options: SdkCallOptions): Promise; /** * Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster. */ startDBCluster(input: AWS.DocDB.StartDBClusterMessage, options: SdkCallOptions): Promise; /** * Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster. */ stopDBCluster(input: AWS.DocDB.StopDBClusterMessage, options: SdkCallOptions): Promise; } export interface Drs { /** * Create an extended source server in the target Account based on the source server in staging account. */ createExtendedSourceServer(input: AWS.Drs.CreateExtendedSourceServerRequest, options: SdkCallOptions): Promise; /** * Creates a new ReplicationConfigurationTemplate. */ createReplicationConfigurationTemplate(input: AWS.Drs.CreateReplicationConfigurationTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a single Job by ID. */ deleteJob(input: AWS.Drs.DeleteJobRequest, options: SdkCallOptions): Promise; /** * Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it. */ deleteRecoveryInstance(input: AWS.Drs.DeleteRecoveryInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a single Replication Configuration Template by ID */ deleteReplicationConfigurationTemplate(input: AWS.Drs.DeleteReplicationConfigurationTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a single Source Server by ID. The Source Server must be disconnected first. */ deleteSourceServer(input: AWS.Drs.DeleteSourceServerRequest, options: SdkCallOptions): Promise; /** * Retrieves a detailed Job log with pagination. */ describeJobLogItems(input: AWS.Drs.DescribeJobLogItemsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets. */ describeJobs(input: AWS.Drs.DescribeJobsRequest, options: SdkCallOptions): Promise; /** * Lists all Recovery Instances or multiple Recovery Instances by ID. */ describeRecoveryInstances(input: AWS.Drs.DescribeRecoveryInstancesRequest, options: SdkCallOptions): Promise; /** * Lists all Recovery Snapshots for a single Source Server. */ describeRecoverySnapshots(input: AWS.Drs.DescribeRecoverySnapshotsRequest, options: SdkCallOptions): Promise; /** * Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs. */ describeReplicationConfigurationTemplates(input: AWS.Drs.DescribeReplicationConfigurationTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists all Source Servers or multiple Source Servers filtered by ID. */ describeSourceServers(input: AWS.Drs.DescribeSourceServersRequest, options: SdkCallOptions): Promise; /** * Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified. */ disconnectRecoveryInstance(input: AWS.Drs.DisconnectRecoveryInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified. */ disconnectSourceServer(input: AWS.Drs.DisconnectSourceServerRequest, options: SdkCallOptions): Promise; /** * Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID. */ getFailbackReplicationConfiguration(input: AWS.Drs.GetFailbackReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets a LaunchConfiguration, filtered by Source Server IDs. */ getLaunchConfiguration(input: AWS.Drs.GetLaunchConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets a ReplicationConfiguration, filtered by Source Server ID. */ getReplicationConfiguration(input: AWS.Drs.GetReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Initialize Elastic Disaster Recovery. */ initializeService(input: AWS.Drs.InitializeServiceRequest, options: SdkCallOptions): Promise; /** * Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server. */ listExtensibleSourceServers(input: AWS.Drs.ListExtensibleSourceServersRequest, options: SdkCallOptions): Promise; /** * Returns an array of staging accounts for existing extended source servers. */ listStagingAccounts(input: AWS.Drs.ListStagingAccountsRequest, options: SdkCallOptions): Promise; /** * List all tags for your Elastic Disaster Recovery resources. */ listTagsForResource(input: AWS.Drs.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state. */ retryDataReplication(input: AWS.Drs.RetryDataReplicationRequest, options: SdkCallOptions): Promise; /** * Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process. */ startFailbackLaunch(input: AWS.Drs.StartFailbackLaunchRequest, options: SdkCallOptions): Promise; /** * Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot. */ startRecovery(input: AWS.Drs.StartRecoveryRequest, options: SdkCallOptions): Promise; /** * Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED. */ stopFailback(input: AWS.Drs.StopFailbackRequest, options: SdkCallOptions): Promise<{}>; /** * Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. */ tagResource(input: AWS.Drs.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service. */ terminateRecoveryInstances(input: AWS.Drs.TerminateRecoveryInstancesRequest, options: SdkCallOptions): Promise; /** * Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources. */ untagResource(input: AWS.Drs.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Allows you to update the failback replication configuration of a Recovery Instance by ID. */ updateFailbackReplicationConfiguration(input: AWS.Drs.UpdateFailbackReplicationConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a LaunchConfiguration by Source Server ID. */ updateLaunchConfiguration(input: AWS.Drs.UpdateLaunchConfigurationRequest, options: SdkCallOptions): Promise; /** * Allows you to update a ReplicationConfiguration by Source Server ID. */ updateReplicationConfiguration(input: AWS.Drs.UpdateReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates a ReplicationConfigurationTemplate by ID. */ updateReplicationConfigurationTemplate(input: AWS.Drs.UpdateReplicationConfigurationTemplateRequest, options: SdkCallOptions): Promise; } export interface DynamoDB { /** * This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. The entire batch must consist of either read statements or write statements, you cannot mix both in one batch. A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement. */ batchExecuteStatement(input: AWS.DynamoDB.BatchExecuteStatementInput, options: SdkCallOptions): Promise; /** * The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get. If you request more than 100 items, BatchGetItem returns a ValidationException with the message "Too many items requested for the BatchGetItem call." For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset. If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables. In order to minimize response latency, BatchGetItem retrieves items in parallel. When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter. If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide. */ batchGetItem(input: AWS.DynamoDB.BatchGetItemInput, options: SdkCallOptions): Promise; /** * The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. To update items, use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB. */ batchWriteItem(input: AWS.DynamoDB.BatchWriteItemInput, options: SdkCallOptions): Promise; /** * Creates a backup for an existing table. Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken. When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes. You can call CreateBackup at a maximum rate of 50 times per second. All backups in DynamoDB work without consuming any provisioned throughput on the table. If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency. Along with data, the following are also included on the backups: Global secondary indexes (GSIs) Local secondary indexes (LSIs) Streams Provisioned read and write capacity */ createBackup(input: AWS.DynamoDB.CreateBackupInput, options: SdkCallOptions): Promise; /** * Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions. This operation only applies to Version 2017.11.29 of global tables. If you want to add a new replica table to a global table, each of the following conditions must be true: The table must have the same primary key as all of the other replicas. The table must have the same name as all of the other replicas. The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item. None of the replica tables in the global table can contain any data. If global secondary indexes are specified, then the following conditions must also be met: The global secondary indexes must have the same name. The global secondary indexes must have the same hash key and sort key (if present). If local secondary indexes are specified, then the following conditions must also be met: The local secondary indexes must have the same name. The local secondary indexes must have the same hash key and sort key (if present). Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes. If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table. */ createGlobalTable(input: AWS.DynamoDB.CreateGlobalTableInput, options: SdkCallOptions): Promise; /** * The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions. CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table. You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time. You can use the DescribeTable action to check the table status. */ createTable(input: AWS.DynamoDB.CreateTableInput, options: SdkCallOptions): Promise; /** * Deletes an existing backup of a table. You can call DeleteBackup at a maximum rate of 10 times per second. */ deleteBackup(input: AWS.DynamoDB.DeleteBackupInput, options: SdkCallOptions): Promise; /** * Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter. Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. */ deleteItem(input: AWS.DynamoDB.DeleteItemInput, options: SdkCallOptions): Promise; /** * The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned. DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. When you delete a table, any indexes on that table are also deleted. If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours. Use the DescribeTable action to check the status of the table. */ deleteTable(input: AWS.DynamoDB.DeleteTableInput, options: SdkCallOptions): Promise; /** * Describes an existing backup of a table. You can call DescribeBackup at a maximum rate of 10 times per second. */ describeBackup(input: AWS.DynamoDB.DescribeBackupInput, options: SdkCallOptions): Promise; /** * Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED. After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days. You can call DescribeContinuousBackups at a maximum rate of 10 times per second. */ describeContinuousBackups(input: AWS.DynamoDB.DescribeContinuousBackupsInput, options: SdkCallOptions): Promise; /** * Returns information about contributor insights, for a given table or global secondary index. */ describeContributorInsights(input: AWS.DynamoDB.DescribeContributorInsightsInput, options: SdkCallOptions): Promise; /** * Returns the regional endpoint information. */ describeEndpoints(input: AWS.DynamoDB.DescribeEndpointsRequest, options: SdkCallOptions): Promise; /** * Describes an existing table export. */ describeExport(input: AWS.DynamoDB.DescribeExportInput, options: SdkCallOptions): Promise; /** * Returns information about the specified global table. This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use DescribeTable instead. */ describeGlobalTable(input: AWS.DynamoDB.DescribeGlobalTableInput, options: SdkCallOptions): Promise; /** * Describes Region-specific settings for a global table. This operation only applies to Version 2017.11.29 of global tables. */ describeGlobalTableSettings(input: AWS.DynamoDB.DescribeGlobalTableSettingsInput, options: SdkCallOptions): Promise; /** * Represents the properties of the import. */ describeImport(input: AWS.DynamoDB.DescribeImportInput, options: SdkCallOptions): Promise; /** * Returns information about the status of Kinesis streaming. */ describeKinesisStreamingDestination(input: AWS.DynamoDB.DescribeKinesisStreamingDestinationInput, options: SdkCallOptions): Promise; /** * Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there. When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide. Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota. For example, you could use one of the Amazon Web Services SDKs to do the following: Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there. Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both. Call ListTables to obtain a list of all your DynamoDB tables. For each table name listed by ListTables, do the following: Call DescribeTable with the table name. Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables. If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well. Report the account quotas for that Region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated. This will let you see whether you are getting close to your account-level quotas. The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes. For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas. DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute. The DescribeLimits Request element has no content. */ describeLimits(input: AWS.DynamoDB.DescribeLimitsInput, options: SdkCallOptions): Promise; /** * Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again. */ describeTable(input: AWS.DynamoDB.DescribeTableInput, options: SdkCallOptions): Promise; /** * Describes auto scaling settings across replicas of the global table at once. This operation only applies to Version 2019.11.21 of global tables. */ describeTableReplicaAutoScaling(input: AWS.DynamoDB.DescribeTableReplicaAutoScalingInput, options: SdkCallOptions): Promise; /** * Gives a description of the Time to Live (TTL) status on the specified table. */ describeTimeToLive(input: AWS.DynamoDB.DescribeTimeToLiveInput, options: SdkCallOptions): Promise; /** * Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources. */ disableKinesisStreamingDestination(input: AWS.DynamoDB.KinesisStreamingDestinationInput, options: SdkCallOptions): Promise; /** * Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE. */ enableKinesisStreamingDestination(input: AWS.DynamoDB.KinesisStreamingDestinationInput, options: SdkCallOptions): Promise; /** * This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL. For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set. A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set. */ executeStatement(input: AWS.DynamoDB.ExecuteStatementInput, options: SdkCallOptions): Promise; /** * This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL. The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API. */ executeTransaction(input: AWS.DynamoDB.ExecuteTransactionInput, options: SdkCallOptions): Promise; /** * Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window. */ exportTableToPointInTime(input: AWS.DynamoDB.ExportTableToPointInTimeInput, options: SdkCallOptions): Promise; /** * The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response. GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. */ getItem(input: AWS.DynamoDB.GetItemInput, options: SdkCallOptions): Promise; /** * Imports table data from an S3 bucket. */ importTable(input: AWS.DynamoDB.ImportTableInput, options: SdkCallOptions): Promise; /** * List backups associated with an Amazon Web Services account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page. In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested. You can call ListBackups a maximum of five times per second. */ listBackups(input: AWS.DynamoDB.ListBackupsInput, options: SdkCallOptions): Promise; /** * Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes. */ listContributorInsights(input: AWS.DynamoDB.ListContributorInsightsInput, options: SdkCallOptions): Promise; /** * Lists completed exports within the past 90 days. */ listExports(input: AWS.DynamoDB.ListExportsInput, options: SdkCallOptions): Promise; /** * Lists all global tables that have a replica in the specified Region. This operation only applies to Version 2017.11.29 of global tables. */ listGlobalTables(input: AWS.DynamoDB.ListGlobalTablesInput, options: SdkCallOptions): Promise; /** * Lists completed imports within the past 90 days. */ listImports(input: AWS.DynamoDB.ListImportsInput, options: SdkCallOptions): Promise; /** * Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names. */ listTables(input: AWS.DynamoDB.ListTablesInput, options: SdkCallOptions): Promise; /** * List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. */ listTagsOfResource(input: AWS.DynamoDB.ListTagsOfResourceInput, options: SdkCallOptions): Promise; /** * Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the ReturnValues parameter. When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null. Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty. Invalid Requests with empty values will be rejected with a ValidationException exception. To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists. For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide. */ putItem(input: AWS.DynamoDB.PutItemInput, options: SdkCallOptions): Promise; /** * You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results. Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded. A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation. DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression. Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false. A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide. FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression. A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out. You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index. */ query(input: AWS.DynamoDB.QueryInput, options: SdkCallOptions): Promise; /** * Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. You can call RestoreTableFromBackup at a maximum rate of 10 times per second. You must manually set up the following on the restored table: Auto scaling policies IAM policies Amazon CloudWatch metrics and alarms Tags Stream settings Time to Live (TTL) settings */ restoreTableFromBackup(input: AWS.DynamoDB.RestoreTableFromBackupInput, options: SdkCallOptions): Promise; /** * Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table. Along with data, the following are also included on the new restored table using point in time recovery: Global secondary indexes (GSIs) Local secondary indexes (LSIs) Provisioned read and write capacity Encryption settings All these settings come from the current settings of the source table at the time of restore. You must manually set up the following on the restored table: Auto scaling policies IAM policies Amazon CloudWatch metrics and alarms Tags Stream settings Time to Live (TTL) settings Point in time recovery settings */ restoreTableToPointInTime(input: AWS.DynamoDB.RestoreTableToPointInTimeInput, options: SdkCallOptions): Promise; /** * The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation. If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. A single Scan operation reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide. Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide. Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true. */ scan(input: AWS.DynamoDB.ScanInput, options: SdkCallOptions): Promise; /** * Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. */ tagResource(input: AWS.DynamoDB.TagResourceInput, options: SdkCallOptions): Promise<{}>; /** * TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 100 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one Amazon Web Services account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB. DynamoDB rejects the entire TransactGetItems request if any of the following is true: A conflicting operation is in the process of updating an item to be read. There is insufficient provisioned capacity for the transaction to be completed. There is a user error, such as an invalid data format. The aggregate size of the items in the transaction cannot exceed 4 MB. */ transactGetItems(input: AWS.DynamoDB.TransactGetItemsInput, options: SdkCallOptions): Promise; /** * TransactWriteItems is a synchronous write operation that groups up to 100 action requests. These actions can target items in different tables, but not in different Amazon Web Services accounts or Regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size of the items in the transaction cannot exceed 4 MB. The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects: Put  —   Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met. Update  —   Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met. Delete  —   Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met. ConditionCheck  —   Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met. DynamoDB rejects the entire TransactWriteItems request if any of the following is true: A condition in one of the condition expressions is not met. An ongoing operation is in the process of updating the same item. There is insufficient provisioned capacity for the transaction to be completed. An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction. The aggregate size of the items in the transaction exceeds 4 MB. There is a user error, such as an invalid data format. */ transactWriteItems(input: AWS.DynamoDB.TransactWriteItemsInput, options: SdkCallOptions): Promise; /** * Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account. For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide. */ untagResource(input: AWS.DynamoDB.UntagResourceInput, options: SdkCallOptions): Promise<{}>; /** * UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED. Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime. LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days. */ updateContinuousBackups(input: AWS.DynamoDB.UpdateContinuousBackupsInput, options: SdkCallOptions): Promise; /** * Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table. */ updateContributorInsights(input: AWS.DynamoDB.UpdateContributorInsightsInput, options: SdkCallOptions): Promise; /** * Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units. Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas. If global secondary indexes are specified, then the following conditions must also be met: The global secondary indexes must have the same name. The global secondary indexes must have the same hash key and sort key (if present). The global secondary indexes must have the same provisioned and maximum write capacity units. */ updateGlobalTable(input: AWS.DynamoDB.UpdateGlobalTableInput, options: SdkCallOptions): Promise; /** * Updates settings for a global table. */ updateGlobalTableSettings(input: AWS.DynamoDB.UpdateGlobalTableSettingsInput, options: SdkCallOptions): Promise; /** * Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter. */ updateItem(input: AWS.DynamoDB.UpdateItemInput, options: SdkCallOptions): Promise; /** * Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. You can only perform one of the following operations at once: Modify the provisioned throughput settings of the table. Remove a global secondary index from the table. Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations. UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete. */ updateTable(input: AWS.DynamoDB.UpdateTableInput, options: SdkCallOptions): Promise; /** * Updates auto scaling settings on your global tables at once. This operation only applies to Version 2019.11.21 of global tables. */ updateTableReplicaAutoScaling(input: AWS.DynamoDB.UpdateTableReplicaAutoScalingInput, options: SdkCallOptions): Promise; /** * The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException. TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted. The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC. DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans. As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation. For more information, see Time To Live in the Amazon DynamoDB Developer Guide. */ updateTimeToLive(input: AWS.DynamoDB.UpdateTimeToLiveInput, options: SdkCallOptions): Promise; } export interface DynamoDBStreams { /** * Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. You can call DescribeStream at a maximum rate of 10 times per second. Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data. */ describeStream(input: AWS.DynamoDBStreams.DescribeStreamInput, options: SdkCallOptions): Promise; /** * Retrieves the stream records from a given shard. Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first. */ getRecords(input: AWS.DynamoDBStreams.GetRecordsInput, options: SdkCallOptions): Promise; /** * Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard. A shard iterator expires 15 minutes after it is returned to the requester. */ getShardIterator(input: AWS.DynamoDBStreams.GetShardIteratorInput, options: SdkCallOptions): Promise; /** * Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table. You can call ListStreams at a maximum rate of 5 times per second. */ listStreams(input: AWS.DynamoDBStreams.ListStreamsInput, options: SdkCallOptions): Promise; } export interface EBS { /** * Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed. */ completeSnapshot(input: AWS.EBS.CompleteSnapshotRequest, options: SdkCallOptions): Promise; /** * Returns the data in a block in an Amazon Elastic Block Store snapshot. */ getSnapshotBlock(input: AWS.EBS.GetSnapshotBlockRequest, options: SdkCallOptions): Promise; /** * Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage. */ listChangedBlocks(input: AWS.EBS.ListChangedBlocksRequest, options: SdkCallOptions): Promise; /** * Returns information about the blocks in an Amazon Elastic Block Store snapshot. */ listSnapshotBlocks(input: AWS.EBS.ListSnapshotBlocksRequest, options: SdkCallOptions): Promise; /** * Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state. Data written to a snapshot must be aligned with 512-KiB sectors. */ putSnapshotBlock(input: AWS.EBS.PutSnapshotBlockRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes. After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot. */ startSnapshot(input: AWS.EBS.StartSnapshotRequest, options: SdkCallOptions): Promise; } export interface EC2 { /** * Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call. */ acceptReservedInstancesExchangeQuote(input: AWS.EC2.AcceptReservedInstancesExchangeQuoteRequest, options: SdkCallOptions): Promise; /** * Accepts a request to associate subnets with a transit gateway multicast domain. */ acceptTransitGatewayMulticastDomainAssociations(input: AWS.EC2.AcceptTransitGatewayMulticastDomainAssociationsRequest, options: SdkCallOptions): Promise; /** * Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state. */ acceptTransitGatewayPeeringAttachment(input: AWS.EC2.AcceptTransitGatewayPeeringAttachmentRequest, options: SdkCallOptions): Promise; /** * Accepts a request to attach a VPC to a transit gateway. The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request. */ acceptTransitGatewayVpcAttachment(input: AWS.EC2.AcceptTransitGatewayVpcAttachmentRequest, options: SdkCallOptions): Promise; /** * Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service. */ acceptVpcEndpointConnections(input: AWS.EC2.AcceptVpcEndpointConnectionsRequest, options: SdkCallOptions): Promise; /** * Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests. For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC. */ acceptVpcPeeringConnection(input: AWS.EC2.AcceptVpcPeeringConnectionRequest, options: SdkCallOptions): Promise; /** * Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services. It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays. To stop advertising the BYOIP CIDR, use WithdrawByoipCidr. */ advertiseByoipCidr(input: AWS.EC2.AdvertiseByoipCidrRequest, options: SdkCallOptions): Promise; /** * Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account. You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. [EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation. An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance). We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ allocateAddress(input: AWS.EC2.AllocateAddressRequest, options: SdkCallOptions): Promise; /** * Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate. */ allocateHosts(input: AWS.EC2.AllocateHostsRequest, options: SdkCallOptions): Promise; /** * Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide. */ allocateIpamPoolCidr(input: AWS.EC2.AllocateIpamPoolCidrRequest, options: SdkCallOptions): Promise; /** * Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups. */ applySecurityGroupsToClientVpnTargetNetwork(input: AWS.EC2.ApplySecurityGroupsToClientVpnTargetNetworkRequest, options: SdkCallOptions): Promise; /** * Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide. You must specify either the IPv6 addresses or the IPv6 address count in the request. You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide. */ assignIpv6Addresses(input: AWS.EC2.AssignIpv6AddressesRequest, options: SdkCallOptions): Promise; /** * Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved. Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete. You must specify either the IP addresses or the IP address count in the request. You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide. */ assignPrivateIpAddresses(input: AWS.EC2.AssignPrivateIpAddressesRequest, options: SdkCallOptions): Promise; /** * Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account. [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address. [Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface. You cannot associate an Elastic IP address with an interface in a different network border group. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ associateAddress(input: AWS.EC2.AssociateAddressRequest, options: SdkCallOptions): Promise; /** * Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy. If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it. */ associateClientVpnTargetNetwork(input: AWS.EC2.AssociateClientVpnTargetNetworkRequest, options: SdkCallOptions): Promise; /** * Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide. */ associateDhcpOptions(input: AWS.EC2.AssociateDhcpOptionsRequest, options: SdkCallOptions): Promise<{}>; /** * Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide. When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy. To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide. */ associateEnclaveCertificateIamRole(input: AWS.EC2.AssociateEnclaveCertificateIamRoleRequest, options: SdkCallOptions): Promise; /** * Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. */ associateIamInstanceProfile(input: AWS.EC2.AssociateIamInstanceProfileRequest, options: SdkCallOptions): Promise; /** * Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide. */ associateInstanceEventWindow(input: AWS.EC2.AssociateInstanceEventWindowRequest, options: SdkCallOptions): Promise; /** * Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets. For more information, see Route tables in the Amazon Virtual Private Cloud User Guide. */ associateRouteTable(input: AWS.EC2.AssociateRouteTableRequest, options: SdkCallOptions): Promise; /** * Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. */ associateSubnetCidrBlock(input: AWS.EC2.AssociateSubnetCidrBlockRequest, options: SdkCallOptions): Promise; /** * Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain. The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment. */ associateTransitGatewayMulticastDomain(input: AWS.EC2.AssociateTransitGatewayMulticastDomainRequest, options: SdkCallOptions): Promise; /** * Associates the specified transit gateway attachment with a transit gateway policy table. */ associateTransitGatewayPolicyTable(input: AWS.EC2.AssociateTransitGatewayPolicyTableRequest, options: SdkCallOptions): Promise; /** * Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. */ associateTransitGatewayRouteTable(input: AWS.EC2.AssociateTransitGatewayRouteTableRequest, options: SdkCallOptions): Promise; /** * This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager. Associates a branch network interface with a trunk network interface. Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface. */ associateTrunkInterface(input: AWS.EC2.AssociateTrunkInterfaceRequest, options: SdkCallOptions): Promise; /** * Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56. You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block. For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide. */ associateVpcCidrBlock(input: AWS.EC2.AssociateVpcCidrBlockRequest, options: SdkCallOptions): Promise; /** * We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. Linking your instance to a VPC is sometimes referred to as attaching your instance. */ attachClassicLinkVpc(input: AWS.EC2.AttachClassicLinkVpcRequest, options: SdkCallOptions): Promise; /** * Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide. */ attachInternetGateway(input: AWS.EC2.AttachInternetGatewayRequest, options: SdkCallOptions): Promise<{}>; /** * Attaches a network interface to an instance. */ attachNetworkInterface(input: AWS.EC2.AttachNetworkInterfaceRequest, options: SdkCallOptions): Promise; /** * Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use. If a volume has an Amazon Web Services Marketplace product code: The volume can be attached only to a stopped instance. Amazon Web Services Marketplace product codes are copied from the volume to the instance. You must be subscribed to the product. The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance. For more information, see Attach an Amazon EBS volume to an instance in the Amazon Elastic Compute Cloud User Guide. */ attachVolume(input: AWS.EC2.AttachVolumeRequest, options: SdkCallOptions): Promise; /** * Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide. */ attachVpnGateway(input: AWS.EC2.AttachVpnGatewayRequest, options: SdkCallOptions): Promise; /** * Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks. */ authorizeClientVpnIngress(input: AWS.EC2.AuthorizeClientVpnIngressRequest, options: SdkCallOptions): Promise; /** * [VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups. When specifying an outbound rule for your security group in a VPC, the IpPermissions must include a destination for the traffic. You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. For information about VPC security group quotas, see Amazon VPC quotas. */ authorizeSecurityGroupEgress(input: AWS.EC2.AuthorizeSecurityGroupEgressRequest, options: SdkCallOptions): Promise; /** * Adds the specified inbound (ingress) rules to a security group. An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups. When specifying an inbound rule for your security group in a VPC, the IpPermissions must include a source for the traffic. You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. For more information about VPC security group quotas, see Amazon VPC quotas. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ authorizeSecurityGroupIngress(input: AWS.EC2.AuthorizeSecurityGroupIngressRequest, options: SdkCallOptions): Promise; /** * Bundles an Amazon instance store-backed Windows instance. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. */ bundleInstance(input: AWS.EC2.BundleInstanceRequest, options: SdkCallOptions): Promise; /** * Cancels a bundling operation for an instance store-backed Windows instance. */ cancelBundleTask(input: AWS.EC2.CancelBundleTaskRequest, options: SdkCallOptions): Promise; /** * Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity. */ cancelCapacityReservation(input: AWS.EC2.CancelCapacityReservationRequest, options: SdkCallOptions): Promise; /** * Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens: The Capacity Reservation Fleet's status changes to cancelled. The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity. The Fleet stops creating new Capacity Reservations. */ cancelCapacityReservationFleets(input: AWS.EC2.CancelCapacityReservationFleetsRequest, options: SdkCallOptions): Promise; /** * Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI. */ cancelConversionTask(input: AWS.EC2.CancelConversionRequest, options: SdkCallOptions): Promise<{}>; /** * Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. */ cancelExportTask(input: AWS.EC2.CancelExportTaskRequest, options: SdkCallOptions): Promise<{}>; /** * Cancels an in-process import virtual machine or import snapshot task. */ cancelImportTask(input: AWS.EC2.CancelImportTaskRequest, options: SdkCallOptions): Promise; /** * Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide. */ cancelReservedInstancesListing(input: AWS.EC2.CancelReservedInstancesListingRequest, options: SdkCallOptions): Promise; /** * Cancels the specified Spot Fleet requests. After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually. */ cancelSpotFleetRequests(input: AWS.EC2.CancelSpotFleetRequestsRequest, options: SdkCallOptions): Promise; /** * Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request. */ cancelSpotInstanceRequests(input: AWS.EC2.CancelSpotInstanceRequestsRequest, options: SdkCallOptions): Promise; /** * Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support. */ confirmProductInstance(input: AWS.EC2.ConfirmProductInstanceRequest, options: SdkCallOptions): Promise; /** * Copies the specified Amazon FPGA Image (AFI) to the current Region. */ copyFpgaImage(input: AWS.EC2.CopyFpgaImageRequest, options: SdkCallOptions): Promise; /** * Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask. To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot. To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide. For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide. */ copyImage(input: AWS.EC2.CopyImageRequest, options: SdkCallOptions): Promise; /** * Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot. Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide. Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose. For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide. */ copySnapshot(input: AWS.EC2.CopySnapshotRequest, options: SdkCallOptions): Promise; /** * Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide. Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes. Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide. */ createCapacityReservation(input: AWS.EC2.CreateCapacityReservationRequest, options: SdkCallOptions): Promise; /** * Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide. */ createCapacityReservationFleet(input: AWS.EC2.CreateCapacityReservationFleetRequest, options: SdkCallOptions): Promise; /** * Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide. */ createCarrierGateway(input: AWS.EC2.CreateCarrierGatewayRequest, options: SdkCallOptions): Promise; /** * Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. */ createClientVpnEndpoint(input: AWS.EC2.CreateClientVpnEndpointRequest, options: SdkCallOptions): Promise; /** * Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. */ createClientVpnRoute(input: AWS.EC2.CreateClientVpnRouteRequest, options: SdkCallOptions): Promise; /** * Creates a range of customer-owned IP addresses. */ createCoipCidr(input: AWS.EC2.CreateCoipCidrRequest, options: SdkCallOptions): Promise; /** * Creates a pool of customer-owned IP (CoIP) addresses. */ createCoipPool(input: AWS.EC2.CreateCoipPoolRequest, options: SdkCallOptions): Promise; /** * Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT). For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide. To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway. */ createCustomerGateway(input: AWS.EC2.CreateCustomerGatewayRequest, options: SdkCallOptions): Promise; /** * Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide. */ createDefaultSubnet(input: AWS.EC2.CreateDefaultSubnetRequest, options: SdkCallOptions): Promise; /** * Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself. If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region. If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ createDefaultVpc(input: AWS.EC2.CreateDefaultVpcRequest, options: SdkCallOptions): Promise; /** * Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132. domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server. domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name. ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers. netbios-name-servers - The IP addresses of up to four NetBIOS name servers. netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132. Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide. */ createDhcpOptions(input: AWS.EC2.CreateDhcpOptionsRequest, options: SdkCallOptions): Promise; /** * [IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. */ createEgressOnlyInternetGateway(input: AWS.EC2.CreateEgressOnlyInternetGatewayRequest, options: SdkCallOptions): Promise; /** * Launches an EC2 Fleet. You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. For more information, see EC2 Fleet in the Amazon EC2 User Guide. */ createFleet(input: AWS.EC2.CreateFleetRequest, options: SdkCallOptions): Promise; /** * Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC. Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide. When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket. For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide. */ createFlowLogs(input: AWS.EC2.CreateFlowLogsRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs. An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit. */ createFpgaImage(input: AWS.EC2.CreateFpgaImageRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance. If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can't guarantee the file system integrity of the created image. If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide. */ createImage(input: AWS.EC2.CreateImageRequest, options: SdkCallOptions): Promise; /** * Creates an event window in which scheduled events for the associated Amazon EC2 instances can run. You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC. You can create up to 200 event windows per Amazon Web Services Region. When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API. Event windows are applicable only for scheduled events that stop, reboot, or terminate instances. Event windows are not applicable for: Expedited scheduled events and network maintenance events. Unscheduled maintenance such as AutoRecovery and unplanned reboots. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide. */ createInstanceEventWindow(input: AWS.EC2.CreateInstanceEventWindowRequest, options: SdkCallOptions): Promise; /** * Exports a running or stopped instance to an Amazon S3 bucket. For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide. */ createInstanceExportTask(input: AWS.EC2.CreateInstanceExportTaskRequest, options: SdkCallOptions): Promise; /** * Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide. */ createInternetGateway(input: AWS.EC2.CreateInternetGatewayRequest, options: SdkCallOptions): Promise; /** * Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see Create an IPAM in the Amazon VPC IPAM User Guide. */ createIpam(input: AWS.EC2.CreateIpamRequest, options: SdkCallOptions): Promise; /** * Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each. For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide. */ createIpamPool(input: AWS.EC2.CreateIpamPoolRequest, options: SdkCallOptions): Promise; /** * Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict. For more information, see Add a scope in the Amazon VPC IPAM User Guide. */ createIpamScope(input: AWS.EC2.CreateIpamScopeRequest, options: SdkCallOptions): Promise; /** * Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error. The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair. You can have up to 5,000 key pairs per Amazon Web Services Region. For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide. */ createKeyPair(input: AWS.EC2.CreateKeyPairRequest, options: SdkCallOptions): Promise; /** * Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide. If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide. */ createLaunchTemplate(input: AWS.EC2.CreateLaunchTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a new version of a launch template. You can specify an existing version of launch template from which to base the new version. Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions. Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes any changes you require. For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide. */ createLaunchTemplateVersion(input: AWS.EC2.CreateLaunchTemplateVersionRequest, options: SdkCallOptions): Promise; /** * Creates a static route for the specified local gateway route table. You must specify one of the following targets: LocalGatewayVirtualInterfaceGroupId NetworkInterfaceId */ createLocalGatewayRoute(input: AWS.EC2.CreateLocalGatewayRouteRequest, options: SdkCallOptions): Promise; /** * Creates a local gateway route table. */ createLocalGatewayRouteTable(input: AWS.EC2.CreateLocalGatewayRouteTableRequest, options: SdkCallOptions): Promise; /** * Creates a local gateway route table virtual interface group association. */ createLocalGatewayRouteTableVirtualInterfaceGroupAssociation(input: AWS.EC2.CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest, options: SdkCallOptions): Promise; /** * Associates the specified VPC with the specified local gateway route table. */ createLocalGatewayRouteTableVpcAssociation(input: AWS.EC2.CreateLocalGatewayRouteTableVpcAssociationRequest, options: SdkCallOptions): Promise; /** * Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description. */ createManagedPrefixList(input: AWS.EC2.CreateManagedPrefixListRequest, options: SdkCallOptions): Promise; /** * Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway. With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet. With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks. For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide. */ createNatGateway(input: AWS.EC2.CreateNatGatewayRequest, options: SdkCallOptions): Promise; /** * Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. */ createNetworkAcl(input: AWS.EC2.CreateNetworkAclRequest, options: SdkCallOptions): Promise; /** * Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide. */ createNetworkAclEntry(input: AWS.EC2.CreateNetworkAclEntryRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a Network Access Scope. Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide. */ createNetworkInsightsAccessScope(input: AWS.EC2.CreateNetworkInsightsAccessScopeRequest, options: SdkCallOptions): Promise; /** * Creates a path to analyze for reachability. Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer. */ createNetworkInsightsPath(input: AWS.EC2.CreateNetworkInsightsPathRequest, options: SdkCallOptions): Promise; /** * Creates a network interface in the specified subnet. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide. For more information about network interfaces, see Elastic network interfaces in the Amazon Elastic Compute Cloud User Guide. */ createNetworkInterface(input: AWS.EC2.CreateNetworkInterfaceRequest, options: SdkCallOptions): Promise; /** * Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account. You can grant permission to a single Amazon Web Services account only, and only one account at a time. */ createNetworkInterfacePermission(input: AWS.EC2.CreateNetworkInterfacePermissionRequest, options: SdkCallOptions): Promise; /** * Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. For more information, see Placement groups in the Amazon EC2 User Guide. */ createPlacementGroup(input: AWS.EC2.CreatePlacementGroupRequest, options: SdkCallOptions): Promise; /** * Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools. */ createPublicIpv4Pool(input: AWS.EC2.CreatePublicIpv4PoolRequest, options: SdkCallOptions): Promise; /** * Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide. */ createReplaceRootVolumeTask(input: AWS.EC2.CreateReplaceRootVolumeTaskRequest, options: SdkCallOptions): Promise; /** * Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation. Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold. The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation. For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide. */ createReservedInstancesListing(input: AWS.EC2.CreateReservedInstancesListingRequest, options: SdkCallOptions): Promise; /** * Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask. To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide. For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide. */ createRestoreImageTask(input: AWS.EC2.CreateRestoreImageTaskRequest, options: SdkCallOptions): Promise; /** * Creates a route in a route table within a VPC. You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list. When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes: 192.0.2.0/24 (goes to some target A) 192.0.2.0/28 (goes to some target B) Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide. */ createRoute(input: AWS.EC2.CreateRouteRequest, options: SdkCallOptions): Promise; /** * Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. For more information, see Route tables in the Amazon Virtual Private Cloud User Guide. */ createRouteTable(input: AWS.EC2.CreateRouteTableRequest, options: SdkCallOptions): Promise; /** * Creates a security group. A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide. When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress. For more information about VPC security group limits, see Amazon VPC Limits. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ createSecurityGroup(input: AWS.EC2.CreateSecurityGroupRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost. When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot. You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending. To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. */ createSnapshot(input: AWS.EC2.CreateSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set. You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost. */ createSnapshots(input: AWS.EC2.CreateSnapshotsRequest, options: SdkCallOptions): Promise; /** * Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances. */ createSpotDatafeedSubscription(input: AWS.EC2.CreateSpotDatafeedSubscriptionRequest, options: SdkCallOptions): Promise; /** * Stores an AMI as a single object in an Amazon S3 bucket. To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide. For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide. */ createStoreImageTask(input: AWS.EC2.CreateStoreImageTaskRequest, options: SdkCallOptions): Promise; /** * Creates a subnet in a specified VPC. You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC. If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length. Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use. If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide. */ createSubnet(input: AWS.EC2.CreateSubnetRequest, options: SdkCallOptions): Promise; /** * Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide. */ createSubnetCidrReservation(input: AWS.EC2.CreateSubnetCidrReservationRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the Amazon Elastic Compute Cloud User Guide. */ createTags(input: AWS.EC2.CreateTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a Traffic Mirror filter. A Traffic Mirror filter is a set of rules that defines the traffic to mirror. By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services. */ createTrafficMirrorFilter(input: AWS.EC2.CreateTrafficMirrorFilterRequest, options: SdkCallOptions): Promise; /** * Creates a Traffic Mirror filter rule. A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror. You need the Traffic Mirror filter ID when you create the rule. */ createTrafficMirrorFilterRule(input: AWS.EC2.CreateTrafficMirrorFilterRuleRequest, options: SdkCallOptions): Promise; /** * Creates a Traffic Mirror session. A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway. By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror. */ createTrafficMirrorSession(input: AWS.EC2.CreateTrafficMirrorSessionRequest, options: SdkCallOptions): Promise; /** * Creates a target for your Traffic Mirror session. A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway. A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint. To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession. */ createTrafficMirrorTarget(input: AWS.EC2.CreateTrafficMirrorTargetRequest, options: SdkCallOptions): Promise; /** * Creates a transit gateway. You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway. To attach your VPCs, use CreateTransitGatewayVpcAttachment. To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection. When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table. */ createTransitGateway(input: AWS.EC2.CreateTransitGatewayRequest, options: SdkCallOptions): Promise; /** * Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance. A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism. */ createTransitGatewayConnect(input: AWS.EC2.CreateTransitGatewayConnectRequest, options: SdkCallOptions): Promise; /** * Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6). For more information, see Connect peers in the Transit Gateways Guide. */ createTransitGatewayConnectPeer(input: AWS.EC2.CreateTransitGatewayConnectPeerRequest, options: SdkCallOptions): Promise; /** * Creates a multicast domain using the specified transit gateway. The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway. */ createTransitGatewayMulticastDomain(input: AWS.EC2.CreateTransitGatewayMulticastDomainRequest, options: SdkCallOptions): Promise; /** * Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account. After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request. */ createTransitGatewayPeeringAttachment(input: AWS.EC2.CreateTransitGatewayPeeringAttachmentRequest, options: SdkCallOptions): Promise; /** * Creates a transit gateway policy table. */ createTransitGatewayPolicyTable(input: AWS.EC2.CreateTransitGatewayPolicyTableRequest, options: SdkCallOptions): Promise; /** * Creates a reference (route) to a prefix list in a specified transit gateway route table. */ createTransitGatewayPrefixListReference(input: AWS.EC2.CreateTransitGatewayPrefixListReferenceRequest, options: SdkCallOptions): Promise; /** * Creates a static route for the specified transit gateway route table. */ createTransitGatewayRoute(input: AWS.EC2.CreateTransitGatewayRouteRequest, options: SdkCallOptions): Promise; /** * Creates a route table for the specified transit gateway. */ createTransitGatewayRouteTable(input: AWS.EC2.CreateTransitGatewayRouteTableRequest, options: SdkCallOptions): Promise; /** * Advertises a new transit gateway route table. */ createTransitGatewayRouteTableAnnouncement(input: AWS.EC2.CreateTransitGatewayRouteTableAnnouncementRequest, options: SdkCallOptions): Promise; /** * Attaches the specified VPC to the specified transit gateway. If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table. To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute. */ createTransitGatewayVpcAttachment(input: AWS.EC2.CreateTransitGatewayVpcAttachmentRequest, options: SdkCallOptions): Promise; /** * Creates an EBS volume that can be attached to an instance in the same Availability Zone. You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume. You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide. */ createVolume(input: AWS.EC2.CreateVolumeRequest, options: SdkCallOptions): Promise; /** * Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide. You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide. You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide. */ createVpc(input: AWS.EC2.CreateVpcRequest, options: SdkCallOptions): Promise; /** * Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink Guide. */ createVpcEndpoint(input: AWS.EC2.CreateVpcEndpointRequest, options: SdkCallOptions): Promise; /** * Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide. You can create a connection notification for interface endpoints only. */ createVpcEndpointConnectionNotification(input: AWS.EC2.CreateVpcEndpointConnectionNotificationRequest, options: SdkCallOptions): Promise; /** * Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect. Before you create an endpoint service, you must create one of the following for your service: A Network Load Balancer. Service consumers connect to your service using an interface endpoint. A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint. If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see the Amazon Web Services PrivateLink Guide. */ createVpcEndpointServiceConfiguration(input: AWS.EC2.CreateVpcEndpointServiceConfigurationRequest, options: SdkCallOptions): Promise; /** * Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide. The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed. */ createVpcPeeringConnection(input: AWS.EC2.CreateVpcPeeringConnectionRequest, options: SdkCallOptions): Promise; /** * Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1. The response includes information that you need to give to your network administrator to configure your customer gateway. We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device. If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide. */ createVpnConnection(input: AWS.EC2.CreateVpnConnectionRequest, options: SdkCallOptions): Promise; /** * Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide. */ createVpnConnectionRoute(input: AWS.EC2.CreateVpnConnectionRouteRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide. */ createVpnGateway(input: AWS.EC2.CreateVpnGatewayRequest, options: SdkCallOptions): Promise; /** * Deletes a carrier gateway. If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute. */ deleteCarrierGateway(input: AWS.EC2.DeleteCarrierGatewayRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint. */ deleteClientVpnEndpoint(input: AWS.EC2.DeleteClientVpnEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint. */ deleteClientVpnRoute(input: AWS.EC2.DeleteClientVpnRouteRequest, options: SdkCallOptions): Promise; /** * Deletes a range of customer-owned IP addresses. */ deleteCoipCidr(input: AWS.EC2.DeleteCoipCidrRequest, options: SdkCallOptions): Promise; /** * Deletes a pool of customer-owned IP (CoIP) addresses. */ deleteCoipPool(input: AWS.EC2.DeleteCoipPoolRequest, options: SdkCallOptions): Promise; /** * Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. */ deleteCustomerGateway(input: AWS.EC2.DeleteCustomerGatewayRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. */ deleteDhcpOptions(input: AWS.EC2.DeleteDhcpOptionsRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an egress-only internet gateway. */ deleteEgressOnlyInternetGateway(input: AWS.EC2.DeleteEgressOnlyInternetGatewayRequest, options: SdkCallOptions): Promise; /** * Deletes the specified EC2 Fleet. After you delete an EC2 Fleet, it launches no new instances. You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually. For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported. Restrictions You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request. Up to 1000 instances can be terminated in a single request to delete instant fleets. For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide. */ deleteFleets(input: AWS.EC2.DeleteFleetsRequest, options: SdkCallOptions): Promise; /** * Deletes one or more flow logs. */ deleteFlowLogs(input: AWS.EC2.DeleteFlowLogsRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Amazon FPGA Image (AFI). */ deleteFpgaImage(input: AWS.EC2.DeleteFpgaImageRequest, options: SdkCallOptions): Promise; /** * Deletes the specified event window. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide. */ deleteInstanceEventWindow(input: AWS.EC2.DeleteInstanceEventWindowRequest, options: SdkCallOptions): Promise; /** * Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. */ deleteInternetGateway(input: AWS.EC2.DeleteInternetGatewayRequest, options: SdkCallOptions): Promise<{}>; /** * Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs. For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide. */ deleteIpam(input: AWS.EC2.DeleteIpamRequest, options: SdkCallOptions): Promise; /** * Delete an IPAM pool. You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr. For more information, see Delete a pool in the Amazon VPC IPAM User Guide. */ deleteIpamPool(input: AWS.EC2.DeleteIpamPoolRequest, options: SdkCallOptions): Promise; /** * Delete the scope for an IPAM. You cannot delete the default scopes. For more information, see Delete a scope in the Amazon VPC IPAM User Guide. */ deleteIpamScope(input: AWS.EC2.DeleteIpamScopeRequest, options: SdkCallOptions): Promise; /** * Deletes the specified key pair, by removing the public key from Amazon EC2. */ deleteKeyPair(input: AWS.EC2.DeleteKeyPairRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a launch template. Deleting a launch template deletes all of its versions. */ deleteLaunchTemplate(input: AWS.EC2.DeleteLaunchTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate. */ deleteLaunchTemplateVersions(input: AWS.EC2.DeleteLaunchTemplateVersionsRequest, options: SdkCallOptions): Promise; /** * Deletes the specified route from the specified local gateway route table. */ deleteLocalGatewayRoute(input: AWS.EC2.DeleteLocalGatewayRouteRequest, options: SdkCallOptions): Promise; /** * Deletes a local gateway route table. */ deleteLocalGatewayRouteTable(input: AWS.EC2.DeleteLocalGatewayRouteTableRequest, options: SdkCallOptions): Promise; /** * Deletes a local gateway route table virtual interface group association. */ deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation(input: AWS.EC2.DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified association between a VPC and local gateway route table. */ deleteLocalGatewayRouteTableVpcAssociation(input: AWS.EC2.DeleteLocalGatewayRouteTableVpcAssociationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources. */ deleteManagedPrefixList(input: AWS.EC2.DeleteManagedPrefixListRequest, options: SdkCallOptions): Promise; /** * Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables. */ deleteNatGateway(input: AWS.EC2.DeleteNatGatewayRequest, options: SdkCallOptions): Promise; /** * Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. */ deleteNetworkAcl(input: AWS.EC2.DeleteNetworkAclRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified ingress or egress entry (rule) from the specified network ACL. */ deleteNetworkAclEntry(input: AWS.EC2.DeleteNetworkAclEntryRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Network Access Scope. */ deleteNetworkInsightsAccessScope(input: AWS.EC2.DeleteNetworkInsightsAccessScopeRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Network Access Scope analysis. */ deleteNetworkInsightsAccessScopeAnalysis(input: AWS.EC2.DeleteNetworkInsightsAccessScopeAnalysisRequest, options: SdkCallOptions): Promise; /** * Deletes the specified network insights analysis. */ deleteNetworkInsightsAnalysis(input: AWS.EC2.DeleteNetworkInsightsAnalysisRequest, options: SdkCallOptions): Promise; /** * Deletes the specified path. */ deleteNetworkInsightsPath(input: AWS.EC2.DeleteNetworkInsightsPathRequest, options: SdkCallOptions): Promise; /** * Deletes the specified network interface. You must detach the network interface before you can delete it. */ deleteNetworkInterface(input: AWS.EC2.DeleteNetworkInterfaceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment. */ deleteNetworkInterfacePermission(input: AWS.EC2.DeleteNetworkInterfacePermissionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide. */ deletePlacementGroup(input: AWS.EC2.DeletePlacementGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. */ deletePublicIpv4Pool(input: AWS.EC2.DeletePublicIpv4PoolRequest, options: SdkCallOptions): Promise; /** * Deletes the queued purchases for the specified Reserved Instances. */ deleteQueuedReservedInstances(input: AWS.EC2.DeleteQueuedReservedInstancesRequest, options: SdkCallOptions): Promise; /** * Deletes the specified route from the specified route table. */ deleteRoute(input: AWS.EC2.DeleteRouteRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. */ deleteRouteTable(input: AWS.EC2.DeleteRouteTableRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a security group. If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ deleteSecurityGroup(input: AWS.EC2.DeleteSecurityGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. For more information, see Delete an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide. */ deleteSnapshot(input: AWS.EC2.DeleteSnapshotRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the data feed for Spot Instances. */ deleteSpotDatafeedSubscription(input: AWS.EC2.DeleteSpotDatafeedSubscriptionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. */ deleteSubnet(input: AWS.EC2.DeleteSubnetRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a subnet CIDR reservation. */ deleteSubnetCidrReservation(input: AWS.EC2.DeleteSubnetCidrReservationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified set of tags from the specified set of resources. To list the current tags, use DescribeTags. For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. */ deleteTags(input: AWS.EC2.DeleteTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Traffic Mirror filter. You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session. */ deleteTrafficMirrorFilter(input: AWS.EC2.DeleteTrafficMirrorFilterRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Traffic Mirror rule. */ deleteTrafficMirrorFilterRule(input: AWS.EC2.DeleteTrafficMirrorFilterRuleRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Traffic Mirror session. */ deleteTrafficMirrorSession(input: AWS.EC2.DeleteTrafficMirrorSessionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Traffic Mirror target. You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session. */ deleteTrafficMirrorTarget(input: AWS.EC2.DeleteTrafficMirrorTargetRequest, options: SdkCallOptions): Promise; /** * Deletes the specified transit gateway. */ deleteTransitGateway(input: AWS.EC2.DeleteTransitGatewayRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment. */ deleteTransitGatewayConnect(input: AWS.EC2.DeleteTransitGatewayConnectRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Connect peer. */ deleteTransitGatewayConnectPeer(input: AWS.EC2.DeleteTransitGatewayConnectPeerRequest, options: SdkCallOptions): Promise; /** * Deletes the specified transit gateway multicast domain. */ deleteTransitGatewayMulticastDomain(input: AWS.EC2.DeleteTransitGatewayMulticastDomainRequest, options: SdkCallOptions): Promise; /** * Deletes a transit gateway peering attachment. */ deleteTransitGatewayPeeringAttachment(input: AWS.EC2.DeleteTransitGatewayPeeringAttachmentRequest, options: SdkCallOptions): Promise; /** * Deletes the specified transit gateway policy table. */ deleteTransitGatewayPolicyTable(input: AWS.EC2.DeleteTransitGatewayPolicyTableRequest, options: SdkCallOptions): Promise; /** * Deletes a reference (route) to a prefix list in a specified transit gateway route table. */ deleteTransitGatewayPrefixListReference(input: AWS.EC2.DeleteTransitGatewayPrefixListReferenceRequest, options: SdkCallOptions): Promise; /** * Deletes the specified route from the specified transit gateway route table. */ deleteTransitGatewayRoute(input: AWS.EC2.DeleteTransitGatewayRouteRequest, options: SdkCallOptions): Promise; /** * Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it. */ deleteTransitGatewayRouteTable(input: AWS.EC2.DeleteTransitGatewayRouteTableRequest, options: SdkCallOptions): Promise; /** * Advertises to the transit gateway that a transit gateway route table is deleted. */ deleteTransitGatewayRouteTableAnnouncement(input: AWS.EC2.DeleteTransitGatewayRouteTableAnnouncementRequest, options: SdkCallOptions): Promise; /** * Deletes the specified VPC attachment. */ deleteTransitGatewayVpcAttachment(input: AWS.EC2.DeleteTransitGatewayVpcAttachmentRequest, options: SdkCallOptions): Promise; /** * Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance). The volume can remain in the deleting state for several minutes. For more information, see Delete an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide. */ deleteVolume(input: AWS.EC2.DeleteVolumeRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. */ deleteVpc(input: AWS.EC2.DeleteVpcRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes one or more VPC endpoint connection notifications. */ deleteVpcEndpointConnectionNotifications(input: AWS.EC2.DeleteVpcEndpointConnectionNotificationsRequest, options: SdkCallOptions): Promise; /** * Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service. */ deleteVpcEndpointServiceConfigurations(input: AWS.EC2.DeleteVpcEndpointServiceConfigurationsRequest, options: SdkCallOptions): Promise; /** * Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints. Gateway endpoint, Gateway Load Balancer endpoint, Interface endpoint The following rules apply when you delete a VPC endpoint: When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint. When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces. You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted. When you delete an interface endpoint, we delete the endpoint network interfaces. */ deleteVpcEndpoints(input: AWS.EC2.DeleteVpcEndpointsRequest, options: SdkCallOptions): Promise; /** * Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state. */ deleteVpcPeeringConnection(input: AWS.EC2.DeleteVpcPeeringConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified VPN connection. If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID. For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection. */ deleteVpnConnection(input: AWS.EC2.DeleteVpnConnectionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. */ deleteVpnConnectionRoute(input: AWS.EC2.DeleteVpnConnectionRouteRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. */ deleteVpnGateway(input: AWS.EC2.DeleteVpnGatewayRequest, options: SdkCallOptions): Promise<{}>; /** * Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range. */ deprovisionByoipCidr(input: AWS.EC2.DeprovisionByoipCidrRequest, options: SdkCallOptions): Promise; /** * Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide. */ deprovisionIpamPoolCidr(input: AWS.EC2.DeprovisionIpamPoolCidrRequest, options: SdkCallOptions): Promise; /** * Deprovision a CIDR from a public IPv4 pool. */ deprovisionPublicIpv4PoolCidr(input: AWS.EC2.DeprovisionPublicIpv4PoolCidrRequest, options: SdkCallOptions): Promise; /** * Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances. If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide. When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them. When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI. */ deregisterImage(input: AWS.EC2.DeregisterImageRequest, options: SdkCallOptions): Promise<{}>; /** * Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. */ deregisterInstanceEventNotificationAttributes(input: AWS.EC2.DeregisterInstanceEventNotificationAttributesRequest, options: SdkCallOptions): Promise; /** * Deregisters the specified members (network interfaces) from the transit gateway multicast group. */ deregisterTransitGatewayMulticastGroupMembers(input: AWS.EC2.DeregisterTransitGatewayMulticastGroupMembersRequest, options: SdkCallOptions): Promise; /** * Deregisters the specified sources (network interfaces) from the transit gateway multicast group. */ deregisterTransitGatewayMulticastGroupSources(input: AWS.EC2.DeregisterTransitGatewayMulticastGroupSourcesRequest, options: SdkCallOptions): Promise; /** * Describes attributes of your Amazon Web Services account. The following are the supported account attributes: supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. default-vpc: The ID of the default VPC for your account, or none. max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide. vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface. max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide. */ describeAccountAttributes(input: AWS.EC2.DescribeAccountAttributesRequest, options: SdkCallOptions): Promise; /** * Describes the specified Elastic IP addresses or all of your Elastic IP addresses. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ describeAddresses(input: AWS.EC2.DescribeAddressesRequest, options: SdkCallOptions): Promise; /** * Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications. */ describeAddressesAttribute(input: AWS.EC2.DescribeAddressesAttributeRequest, options: SdkCallOptions): Promise; /** * Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs). This request only returns information about resource types that support longer IDs. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. */ describeAggregateIdFormat(input: AWS.EC2.DescribeAggregateIdFormatRequest, options: SdkCallOptions): Promise; /** * Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone. For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide. */ describeAvailabilityZones(input: AWS.EC2.DescribeAvailabilityZonesRequest, options: SdkCallOptions): Promise; /** * Describes the specified bundle tasks or all of your bundle tasks. Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task. */ describeBundleTasks(input: AWS.EC2.DescribeBundleTasksRequest, options: SdkCallOptions): Promise; /** * Describes the IP address ranges that were specified in calls to ProvisionByoipCidr. To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools. */ describeByoipCidrs(input: AWS.EC2.DescribeByoipCidrsRequest, options: SdkCallOptions): Promise; /** * Describes one or more Capacity Reservation Fleets. */ describeCapacityReservationFleets(input: AWS.EC2.DescribeCapacityReservationFleetsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using. */ describeCapacityReservations(input: AWS.EC2.DescribeCapacityReservationsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your carrier gateways. */ describeCarrierGateways(input: AWS.EC2.DescribeCarrierGatewaysRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ describeClassicLinkInstances(input: AWS.EC2.DescribeClassicLinkInstancesRequest, options: SdkCallOptions): Promise; /** * Describes the authorization rules for a specified Client VPN endpoint. */ describeClientVpnAuthorizationRules(input: AWS.EC2.DescribeClientVpnAuthorizationRulesRequest, options: SdkCallOptions): Promise; /** * Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint. */ describeClientVpnConnections(input: AWS.EC2.DescribeClientVpnConnectionsRequest, options: SdkCallOptions): Promise; /** * Describes one or more Client VPN endpoints in the account. */ describeClientVpnEndpoints(input: AWS.EC2.DescribeClientVpnEndpointsRequest, options: SdkCallOptions): Promise; /** * Describes the routes for the specified Client VPN endpoint. */ describeClientVpnRoutes(input: AWS.EC2.DescribeClientVpnRoutesRequest, options: SdkCallOptions): Promise; /** * Describes the target networks associated with the specified Client VPN endpoint. */ describeClientVpnTargetNetworks(input: AWS.EC2.DescribeClientVpnTargetNetworksRequest, options: SdkCallOptions): Promise; /** * Describes the specified customer-owned address pools or all of your customer-owned address pools. */ describeCoipPools(input: AWS.EC2.DescribeCoipPoolsRequest, options: SdkCallOptions): Promise; /** * Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide. For information about the import manifest referenced by this API action, see VM Import Manifest. */ describeConversionTasks(input: AWS.EC2.DescribeConversionTasksRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your VPN customer gateways. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide. */ describeCustomerGateways(input: AWS.EC2.DescribeCustomerGatewaysRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your DHCP options sets. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide. */ describeDhcpOptions(input: AWS.EC2.DescribeDhcpOptionsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your egress-only internet gateways. */ describeEgressOnlyInternetGateways(input: AWS.EC2.DescribeEgressOnlyInternetGatewaysRequest, options: SdkCallOptions): Promise; /** * Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics. */ describeElasticGpus(input: AWS.EC2.DescribeElasticGpusRequest, options: SdkCallOptions): Promise; /** * Describes the specified export image tasks or all of your export image tasks. */ describeExportImageTasks(input: AWS.EC2.DescribeExportImageTasksRequest, options: SdkCallOptions): Promise; /** * Describes the specified export instance tasks or all of your export instance tasks. */ describeExportTasks(input: AWS.EC2.DescribeExportTasksRequest, options: SdkCallOptions): Promise; /** * Describe details for Windows AMIs that are configured for faster launching. */ describeFastLaunchImages(input: AWS.EC2.DescribeFastLaunchImagesRequest, options: SdkCallOptions): Promise; /** * Describes the state of fast snapshot restores for your snapshots. */ describeFastSnapshotRestores(input: AWS.EC2.DescribeFastSnapshotRestoresRequest, options: SdkCallOptions): Promise; /** * Describes the events for the specified EC2 Fleet during the specified time. EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours. For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide. */ describeFleetHistory(input: AWS.EC2.DescribeFleetHistoryRequest, options: SdkCallOptions): Promise; /** * Describes the running instances for the specified EC2 Fleet. For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide. */ describeFleetInstances(input: AWS.EC2.DescribeFleetInstancesRequest, options: SdkCallOptions): Promise; /** * Describes the specified EC2 Fleets or all of your EC2 Fleets. For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide. */ describeFleets(input: AWS.EC2.DescribeFleetsRequest, options: SdkCallOptions): Promise; /** * Describes one or more flow logs. To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream. */ describeFlowLogs(input: AWS.EC2.DescribeFlowLogsRequest, options: SdkCallOptions): Promise; /** * Describes the specified attribute of the specified Amazon FPGA Image (AFI). */ describeFpgaImageAttribute(input: AWS.EC2.DescribeFpgaImageAttributeRequest, options: SdkCallOptions): Promise; /** * Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions. */ describeFpgaImages(input: AWS.EC2.DescribeFpgaImagesRequest, options: SdkCallOptions): Promise; /** * Describes the Dedicated Host reservations that are available to purchase. The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide. */ describeHostReservationOfferings(input: AWS.EC2.DescribeHostReservationOfferingsRequest, options: SdkCallOptions): Promise; /** * Describes reservations that are associated with Dedicated Hosts in your account. */ describeHostReservations(input: AWS.EC2.DescribeHostReservationsRequest, options: SdkCallOptions): Promise; /** * Describes the specified Dedicated Hosts or all your Dedicated Hosts. The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released. */ describeHosts(input: AWS.EC2.DescribeHostsRequest, options: SdkCallOptions): Promise; /** * Describes your IAM instance profile associations. */ describeIamInstanceProfileAssociations(input: AWS.EC2.DescribeIamInstanceProfileAssociationsRequest, options: SdkCallOptions): Promise; /** * Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. */ describeIdFormat(input: AWS.EC2.DescribeIdFormatRequest, options: SdkCallOptions): Promise; /** * Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. These settings apply to the principal specified in the request. They do not apply to the principal that makes the request. */ describeIdentityIdFormat(input: AWS.EC2.DescribeIdentityIdFormatRequest, options: SdkCallOptions): Promise; /** * Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. */ describeImageAttribute(input: AWS.EC2.DescribeImageAttributeRequest, options: SdkCallOptions): Promise; /** * Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you. The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions. Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found. */ describeImages(input: AWS.EC2.DescribeImagesRequest, options: SdkCallOptions): Promise; /** * Displays details about an import virtual machine or import snapshot tasks that are already created. */ describeImportImageTasks(input: AWS.EC2.DescribeImportImageTasksRequest, options: SdkCallOptions): Promise; /** * Describes your import snapshot tasks. */ describeImportSnapshotTasks(input: AWS.EC2.DescribeImportSnapshotTasksRequest, options: SdkCallOptions): Promise; /** * Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport */ describeInstanceAttribute(input: AWS.EC2.DescribeInstanceAttributeRequest, options: SdkCallOptions): Promise; /** * Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited. If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance. If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally. For more information, see Burstable performance instances in the Amazon EC2 User Guide. */ describeInstanceCreditSpecifications(input: AWS.EC2.DescribeInstanceCreditSpecificationsRequest, options: SdkCallOptions): Promise; /** * Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. */ describeInstanceEventNotificationAttributes(input: AWS.EC2.DescribeInstanceEventNotificationAttributesRequest, options: SdkCallOptions): Promise; /** * Describes the specified event windows or all event windows. If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide. */ describeInstanceEventWindows(input: AWS.EC2.DescribeInstanceEventWindowsRequest, options: SdkCallOptions): Promise; /** * Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances. Instance status includes the following components: Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide. Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide. Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide. */ describeInstanceStatus(input: AWS.EC2.DescribeInstanceStatusRequest, options: SdkCallOptions): Promise; /** * Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned. */ describeInstanceTypeOfferings(input: AWS.EC2.DescribeInstanceTypeOfferingsRequest, options: SdkCallOptions): Promise; /** * Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types. */ describeInstanceTypes(input: AWS.EC2.DescribeInstanceTypesRequest, options: SdkCallOptions): Promise; /** * Describes the specified instances or all instances. If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally. */ describeInstances(input: AWS.EC2.DescribeInstancesRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your internet gateways. */ describeInternetGateways(input: AWS.EC2.DescribeInternetGatewaysRequest, options: SdkCallOptions): Promise; /** * Get information about your IPAM pools. */ describeIpamPools(input: AWS.EC2.DescribeIpamPoolsRequest, options: SdkCallOptions): Promise; /** * Get information about your IPAM scopes. */ describeIpamScopes(input: AWS.EC2.DescribeIpamScopesRequest, options: SdkCallOptions): Promise; /** * Get information about your IPAM pools. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide. */ describeIpams(input: AWS.EC2.DescribeIpamsRequest, options: SdkCallOptions): Promise; /** * Describes your IPv6 address pools. */ describeIpv6Pools(input: AWS.EC2.DescribeIpv6PoolsRequest, options: SdkCallOptions): Promise; /** * Describes the specified key pairs or all of your key pairs. For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide. */ describeKeyPairs(input: AWS.EC2.DescribeKeyPairsRequest, options: SdkCallOptions): Promise; /** * Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account. */ describeLaunchTemplateVersions(input: AWS.EC2.DescribeLaunchTemplateVersionsRequest, options: SdkCallOptions): Promise; /** * Describes one or more launch templates. */ describeLaunchTemplates(input: AWS.EC2.DescribeLaunchTemplatesRequest, options: SdkCallOptions): Promise; /** * Describes the associations between virtual interface groups and local gateway route tables. */ describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations(input: AWS.EC2.DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest, options: SdkCallOptions): Promise; /** * Describes the specified associations between VPCs and local gateway route tables. */ describeLocalGatewayRouteTableVpcAssociations(input: AWS.EC2.DescribeLocalGatewayRouteTableVpcAssociationsRequest, options: SdkCallOptions): Promise; /** * Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results. */ describeLocalGatewayRouteTables(input: AWS.EC2.DescribeLocalGatewayRouteTablesRequest, options: SdkCallOptions): Promise; /** * Describes the specified local gateway virtual interface groups. */ describeLocalGatewayVirtualInterfaceGroups(input: AWS.EC2.DescribeLocalGatewayVirtualInterfaceGroupsRequest, options: SdkCallOptions): Promise; /** * Describes the specified local gateway virtual interfaces. */ describeLocalGatewayVirtualInterfaces(input: AWS.EC2.DescribeLocalGatewayVirtualInterfacesRequest, options: SdkCallOptions): Promise; /** * Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results. */ describeLocalGateways(input: AWS.EC2.DescribeLocalGatewaysRequest, options: SdkCallOptions): Promise; /** * Describes your managed prefix lists and any Amazon Web Services-managed prefix lists. To view the entries for your prefix list, use GetManagedPrefixListEntries. */ describeManagedPrefixLists(input: AWS.EC2.DescribeManagedPrefixListsRequest, options: SdkCallOptions): Promise; /** * Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. */ describeMovingAddresses(input: AWS.EC2.DescribeMovingAddressesRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your NAT gateways. */ describeNatGateways(input: AWS.EC2.DescribeNatGatewaysRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your network ACLs. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. */ describeNetworkAcls(input: AWS.EC2.DescribeNetworkAclsRequest, options: SdkCallOptions): Promise; /** * Describes the specified Network Access Scope analyses. */ describeNetworkInsightsAccessScopeAnalyses(input: AWS.EC2.DescribeNetworkInsightsAccessScopeAnalysesRequest, options: SdkCallOptions): Promise; /** * Describes the specified Network Access Scopes. */ describeNetworkInsightsAccessScopes(input: AWS.EC2.DescribeNetworkInsightsAccessScopesRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your network insights analyses. */ describeNetworkInsightsAnalyses(input: AWS.EC2.DescribeNetworkInsightsAnalysesRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your paths. */ describeNetworkInsightsPaths(input: AWS.EC2.DescribeNetworkInsightsPathsRequest, options: SdkCallOptions): Promise; /** * Describes a network interface attribute. You can specify only one attribute at a time. */ describeNetworkInterfaceAttribute(input: AWS.EC2.DescribeNetworkInterfaceAttributeRequest, options: SdkCallOptions): Promise; /** * Describes the permissions for your network interfaces. */ describeNetworkInterfacePermissions(input: AWS.EC2.DescribeNetworkInterfacePermissionsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your network interfaces. */ describeNetworkInterfaces(input: AWS.EC2.DescribeNetworkInterfacesRequest, options: SdkCallOptions): Promise; /** * Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide. */ describePlacementGroups(input: AWS.EC2.DescribePlacementGroupsRequest, options: SdkCallOptions): Promise; /** * Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. We recommend that you use DescribeManagedPrefixLists instead. */ describePrefixLists(input: AWS.EC2.DescribePrefixListsRequest, options: SdkCallOptions): Promise; /** * Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference. By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings. The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. */ describePrincipalIdFormat(input: AWS.EC2.DescribePrincipalIdFormatRequest, options: SdkCallOptions): Promise; /** * Describes the specified IPv4 address pools. */ describePublicIpv4Pools(input: AWS.EC2.DescribePublicIpv4PoolsRequest, options: SdkCallOptions): Promise; /** * Describes the Regions that are enabled for your account, or all Regions. For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas. For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference. */ describeRegions(input: AWS.EC2.DescribeRegionsRequest, options: SdkCallOptions): Promise; /** * Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide. */ describeReplaceRootVolumeTasks(input: AWS.EC2.DescribeReplaceRootVolumeTasksRequest, options: SdkCallOptions): Promise; /** * Describes one or more of the Reserved Instances that you purchased. For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide. */ describeReservedInstances(input: AWS.EC2.DescribeReservedInstancesRequest, options: SdkCallOptions): Promise; /** * Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide. */ describeReservedInstancesListings(input: AWS.EC2.DescribeReservedInstancesListingsRequest, options: SdkCallOptions): Promise; /** * Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide. */ describeReservedInstancesModifications(input: AWS.EC2.DescribeReservedInstancesModificationsRequest, options: SdkCallOptions): Promise; /** * Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances. For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide. */ describeReservedInstancesOfferings(input: AWS.EC2.DescribeReservedInstancesOfferingsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your route tables. Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. For more information, see Route tables in the Amazon Virtual Private Cloud User Guide. */ describeRouteTables(input: AWS.EC2.DescribeRouteTablesRequest, options: SdkCallOptions): Promise; /** * Finds available schedules that meet the specified criteria. You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule. */ describeScheduledInstanceAvailability(input: AWS.EC2.DescribeScheduledInstanceAvailabilityRequest, options: SdkCallOptions): Promise; /** * Describes the specified Scheduled Instances or all your Scheduled Instances. */ describeScheduledInstances(input: AWS.EC2.DescribeScheduledInstancesRequest, options: SdkCallOptions): Promise; /** * [VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request. */ describeSecurityGroupReferences(input: AWS.EC2.DescribeSecurityGroupReferencesRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your security group rules. */ describeSecurityGroupRules(input: AWS.EC2.DescribeSecurityGroupRulesRequest, options: SdkCallOptions): Promise; /** * Describes the specified security groups or all of your security groups. A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ describeSecurityGroups(input: AWS.EC2.DescribeSecurityGroupsRequest, options: SdkCallOptions): Promise; /** * Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide. */ describeSnapshotAttribute(input: AWS.EC2.DescribeSnapshotAttributeRequest, options: SdkCallOptions): Promise; /** * Describes the storage tier status of one or more Amazon EBS snapshots. */ describeSnapshotTierStatus(input: AWS.EC2.DescribeSnapshotTierStatusRequest, options: SdkCallOptions): Promise; /** * Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you. The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions. The create volume permissions fall into the following categories: public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots. explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account. implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns. The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own. If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots. If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results. To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores. For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide. */ describeSnapshots(input: AWS.EC2.DescribeSnapshotsRequest, options: SdkCallOptions): Promise; /** * Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances. */ describeSpotDatafeedSubscription(input: AWS.EC2.DescribeSpotDatafeedSubscriptionRequest, options: SdkCallOptions): Promise; /** * Describes the running instances for the specified Spot Fleet. */ describeSpotFleetInstances(input: AWS.EC2.DescribeSpotFleetInstancesRequest, options: SdkCallOptions): Promise; /** * Describes the events for the specified Spot Fleet request during the specified time. Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours. For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide for Linux Instances. */ describeSpotFleetRequestHistory(input: AWS.EC2.DescribeSpotFleetRequestHistoryRequest, options: SdkCallOptions): Promise; /** * Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated. */ describeSpotFleetRequests(input: AWS.EC2.DescribeSpotFleetRequestsRequest, options: SdkCallOptions): Promise; /** * Describes the specified Spot Instance requests. You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot. We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results. Spot Instance requests are deleted four hours after they are canceled and their instances are terminated. */ describeSpotInstanceRequests(input: AWS.EC2.DescribeSpotInstanceRequestsRequest, options: SdkCallOptions): Promise; /** * Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances. When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time. */ describeSpotPriceHistory(input: AWS.EC2.DescribeSpotPriceHistoryRequest, options: SdkCallOptions): Promise; /** * [VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted. */ describeStaleSecurityGroups(input: AWS.EC2.DescribeStaleSecurityGroupsRequest, options: SdkCallOptions): Promise; /** * Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days. For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage. Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed. To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide. For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide. */ describeStoreImageTasks(input: AWS.EC2.DescribeStoreImageTasksRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your subnets. For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide. */ describeSubnets(input: AWS.EC2.DescribeSubnetsRequest, options: SdkCallOptions): Promise; /** * Describes the specified tags for your EC2 resources. For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. */ describeTags(input: AWS.EC2.DescribeTagsRequest, options: SdkCallOptions): Promise; /** * Describes one or more Traffic Mirror filters. */ describeTrafficMirrorFilters(input: AWS.EC2.DescribeTrafficMirrorFiltersRequest, options: SdkCallOptions): Promise; /** * Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results. */ describeTrafficMirrorSessions(input: AWS.EC2.DescribeTrafficMirrorSessionsRequest, options: SdkCallOptions): Promise; /** * Information about one or more Traffic Mirror targets. */ describeTrafficMirrorTargets(input: AWS.EC2.DescribeTrafficMirrorTargetsRequest, options: SdkCallOptions): Promise; /** * Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner. */ describeTransitGatewayAttachments(input: AWS.EC2.DescribeTransitGatewayAttachmentsRequest, options: SdkCallOptions): Promise; /** * Describes one or more Connect peers. */ describeTransitGatewayConnectPeers(input: AWS.EC2.DescribeTransitGatewayConnectPeersRequest, options: SdkCallOptions): Promise; /** * Describes one or more Connect attachments. */ describeTransitGatewayConnects(input: AWS.EC2.DescribeTransitGatewayConnectsRequest, options: SdkCallOptions): Promise; /** * Describes one or more transit gateway multicast domains. */ describeTransitGatewayMulticastDomains(input: AWS.EC2.DescribeTransitGatewayMulticastDomainsRequest, options: SdkCallOptions): Promise; /** * Describes your transit gateway peering attachments. */ describeTransitGatewayPeeringAttachments(input: AWS.EC2.DescribeTransitGatewayPeeringAttachmentsRequest, options: SdkCallOptions): Promise; /** * Describes one or more transit gateway route policy tables. */ describeTransitGatewayPolicyTables(input: AWS.EC2.DescribeTransitGatewayPolicyTablesRequest, options: SdkCallOptions): Promise; /** * Describes one or more transit gateway route table advertisements. */ describeTransitGatewayRouteTableAnnouncements(input: AWS.EC2.DescribeTransitGatewayRouteTableAnnouncementsRequest, options: SdkCallOptions): Promise; /** * Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results. */ describeTransitGatewayRouteTables(input: AWS.EC2.DescribeTransitGatewayRouteTablesRequest, options: SdkCallOptions): Promise; /** * Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results. */ describeTransitGatewayVpcAttachments(input: AWS.EC2.DescribeTransitGatewayVpcAttachmentsRequest, options: SdkCallOptions): Promise; /** * Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results. */ describeTransitGateways(input: AWS.EC2.DescribeTransitGatewaysRequest, options: SdkCallOptions): Promise; /** * This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager. Describes one or more network interface trunk associations. */ describeTrunkInterfaceAssociations(input: AWS.EC2.DescribeTrunkInterfaceAssociationsRequest, options: SdkCallOptions): Promise; /** * Describes the specified attribute of the specified volume. You can specify only one attribute at a time. For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide. */ describeVolumeAttribute(input: AWS.EC2.DescribeVolumeAttributeRequest, options: SdkCallOptions): Promise; /** * Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. The DescribeVolumeStatus operation provides the following information about the specified volumes: Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide. Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data. Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency. Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.) */ describeVolumeStatus(input: AWS.EC2.DescribeVolumeStatusRequest, options: SdkCallOptions): Promise; /** * Describes the specified EBS volumes or all of your EBS volumes. If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results. For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide. */ describeVolumes(input: AWS.EC2.DescribeVolumesRequest, options: SdkCallOptions): Promise; /** * Describes the most recent volume modification request for the specified EBS volumes. If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request. You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide. */ describeVolumesModifications(input: AWS.EC2.DescribeVolumesModificationsRequest, options: SdkCallOptions): Promise; /** * Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. */ describeVpcAttribute(input: AWS.EC2.DescribeVpcAttributeRequest, options: SdkCallOptions): Promise; /** * Describes the ClassicLink status of one or more VPCs. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ describeVpcClassicLink(input: AWS.EC2.DescribeVpcClassicLinkRequest, options: SdkCallOptions): Promise; /** * We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. */ describeVpcClassicLinkDnsSupport(input: AWS.EC2.DescribeVpcClassicLinkDnsSupportRequest, options: SdkCallOptions): Promise; /** * Describes the connection notifications for VPC endpoints and VPC endpoint services. */ describeVpcEndpointConnectionNotifications(input: AWS.EC2.DescribeVpcEndpointConnectionNotificationsRequest, options: SdkCallOptions): Promise; /** * Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance. */ describeVpcEndpointConnections(input: AWS.EC2.DescribeVpcEndpointConnectionsRequest, options: SdkCallOptions): Promise; /** * Describes the VPC endpoint service configurations in your account (your services). */ describeVpcEndpointServiceConfigurations(input: AWS.EC2.DescribeVpcEndpointServiceConfigurationsRequest, options: SdkCallOptions): Promise; /** * Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. */ describeVpcEndpointServicePermissions(input: AWS.EC2.DescribeVpcEndpointServicePermissionsRequest, options: SdkCallOptions): Promise; /** * Describes available services to which you can create a VPC endpoint. When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a. */ describeVpcEndpointServices(input: AWS.EC2.DescribeVpcEndpointServicesRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your VPC endpoints. */ describeVpcEndpoints(input: AWS.EC2.DescribeVpcEndpointsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your VPC peering connections. */ describeVpcPeeringConnections(input: AWS.EC2.DescribeVpcPeeringConnectionsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your VPCs. */ describeVpcs(input: AWS.EC2.DescribeVpcsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your VPN connections. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide. */ describeVpnConnections(input: AWS.EC2.DescribeVpnConnectionsRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your virtual private gateways. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide. */ describeVpnGateways(input: AWS.EC2.DescribeVpnGatewaysRequest, options: SdkCallOptions): Promise; /** * We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. */ detachClassicLinkVpc(input: AWS.EC2.DetachClassicLinkVpcRequest, options: SdkCallOptions): Promise; /** * Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses. */ detachInternetGateway(input: AWS.EC2.DetachInternetGatewayRequest, options: SdkCallOptions): Promise<{}>; /** * Detaches a network interface from an instance. */ detachNetworkInterface(input: AWS.EC2.DetachNetworkInterfaceRequest, options: SdkCallOptions): Promise<{}>; /** * Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance. For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide. */ detachVolume(input: AWS.EC2.DetachVolumeRequest, options: SdkCallOptions): Promise; /** * Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway. */ detachVpnGateway(input: AWS.EC2.DetachVpnGatewayRequest, options: SdkCallOptions): Promise<{}>; /** * Disables EBS encryption by default for your account in the current Region. After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume. Disabling encryption by default does not change the encryption status of your existing volumes. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. */ disableEbsEncryptionByDefault(input: AWS.EC2.DisableEbsEncryptionByDefaultRequest, options: SdkCallOptions): Promise; /** * Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again. To change these settings, you must own the AMI. */ disableFastLaunch(input: AWS.EC2.DisableFastLaunchRequest, options: SdkCallOptions): Promise; /** * Disables fast snapshot restores for the specified snapshots in the specified Availability Zones. */ disableFastSnapshotRestores(input: AWS.EC2.DisableFastSnapshotRestoresRequest, options: SdkCallOptions): Promise; /** * Cancels the deprecation of the specified AMI. For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide. */ disableImageDeprecation(input: AWS.EC2.DisableImageDeprecationRequest, options: SdkCallOptions): Promise; /** * Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. */ disableIpamOrganizationAdminAccount(input: AWS.EC2.DisableIpamOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide. */ disableSerialConsoleAccess(input: AWS.EC2.DisableSerialConsoleAccessRequest, options: SdkCallOptions): Promise; /** * Disables the specified resource attachment from propagating routes to the specified propagation route table. */ disableTransitGatewayRouteTablePropagation(input: AWS.EC2.DisableTransitGatewayRouteTablePropagationRequest, options: SdkCallOptions): Promise; /** * Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. */ disableVgwRoutePropagation(input: AWS.EC2.DisableVgwRoutePropagationRequest, options: SdkCallOptions): Promise<{}>; /** * Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ disableVpcClassicLink(input: AWS.EC2.DisableVpcClassicLinkRequest, options: SdkCallOptions): Promise; /** * Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. You must specify a VPC ID in the request. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ disableVpcClassicLinkDnsSupport(input: AWS.EC2.DisableVpcClassicLinkDnsSupportRequest, options: SdkCallOptions): Promise; /** * Disassociates an Elastic IP address from the instance or network interface it's associated with. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. */ disassociateAddress(input: AWS.EC2.DisassociateAddressRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens: The route that was automatically added for the VPC is deleted All active client connections are terminated New client connections are disallowed The Client VPN endpoint's status changes to pending-associate */ disassociateClientVpnTargetNetwork(input: AWS.EC2.DisassociateClientVpnTargetNetworkRequest, options: SdkCallOptions): Promise; /** * Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate. */ disassociateEnclaveCertificateIamRole(input: AWS.EC2.DisassociateEnclaveCertificateIamRoleRequest, options: SdkCallOptions): Promise; /** * Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID. */ disassociateIamInstanceProfile(input: AWS.EC2.DisassociateIamInstanceProfileRequest, options: SdkCallOptions): Promise; /** * Disassociates one or more targets from an event window. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide. */ disassociateInstanceEventWindow(input: AWS.EC2.DisassociateInstanceEventWindowRequest, options: SdkCallOptions): Promise; /** * Disassociates a subnet or gateway from a route table. After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide. */ disassociateRouteTable(input: AWS.EC2.DisassociateRouteTableRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. */ disassociateSubnetCidrBlock(input: AWS.EC2.DisassociateSubnetCidrBlockRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified subnets from the transit gateway multicast domain. */ disassociateTransitGatewayMulticastDomain(input: AWS.EC2.DisassociateTransitGatewayMulticastDomainRequest, options: SdkCallOptions): Promise; /** * Removes the association between an an attachment and a policy table. */ disassociateTransitGatewayPolicyTable(input: AWS.EC2.DisassociateTransitGatewayPolicyTableRequest, options: SdkCallOptions): Promise; /** * Disassociates a resource attachment from a transit gateway route table. */ disassociateTransitGatewayRouteTable(input: AWS.EC2.DisassociateTransitGatewayRouteTableRequest, options: SdkCallOptions): Promise; /** * This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager. Removes an association between a branch network interface with a trunk network interface. */ disassociateTrunkInterface(input: AWS.EC2.DisassociateTrunkInterfaceRequest, options: SdkCallOptions): Promise; /** * Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block). */ disassociateVpcCidrBlock(input: AWS.EC2.DisassociateVpcCidrBlockRequest, options: SdkCallOptions): Promise; /** * Enables EBS encryption by default for your account in the current Region. After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId. Enabling encryption by default has no effect on the encryption status of your existing volumes. After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types. */ enableEbsEncryptionByDefault(input: AWS.EC2.EnableEbsEncryptionByDefaultRequest, options: SdkCallOptions): Promise; /** * When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency. To change these settings, you must own the AMI. */ enableFastLaunch(input: AWS.EC2.EnableFastLaunchRequest, options: SdkCallOptions): Promise; /** * Enables fast snapshot restores for the specified snapshots in the specified Availability Zones. You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores. For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide. */ enableFastSnapshotRestores(input: AWS.EC2.EnableFastSnapshotRestoresRequest, options: SdkCallOptions): Promise; /** * Enables deprecation of the specified AMI at the specified date and time. For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide. */ enableImageDeprecation(input: AWS.EC2.EnableImageDeprecationRequest, options: SdkCallOptions): Promise; /** * Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. */ enableIpamOrganizationAdminAccount(input: AWS.EC2.EnableIpamOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide. */ enableSerialConsoleAccess(input: AWS.EC2.EnableSerialConsoleAccessRequest, options: SdkCallOptions): Promise; /** * Enables the specified attachment to propagate routes to the specified propagation route table. */ enableTransitGatewayRouteTablePropagation(input: AWS.EC2.EnableTransitGatewayRouteTablePropagationRequest, options: SdkCallOptions): Promise; /** * Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. */ enableVgwRoutePropagation(input: AWS.EC2.EnableVgwRoutePropagationRequest, options: SdkCallOptions): Promise<{}>; /** * Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. */ enableVolumeIO(input: AWS.EC2.EnableVolumeIORequest, options: SdkCallOptions): Promise<{}>; /** * We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. */ enableVpcClassicLink(input: AWS.EC2.EnableVpcClassicLinkRequest, options: SdkCallOptions): Promise; /** * We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. You must specify a VPC ID in the request. */ enableVpcClassicLinkDnsSupport(input: AWS.EC2.EnableVpcClassicLinkDnsSupportRequest, options: SdkCallOptions): Promise; /** * Downloads the client certificate revocation list for the specified Client VPN endpoint. */ exportClientVpnClientCertificateRevocationList(input: AWS.EC2.ExportClientVpnClientCertificateRevocationListRequest, options: SdkCallOptions): Promise; /** * Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint. */ exportClientVpnClientConfiguration(input: AWS.EC2.ExportClientVpnClientConfigurationRequest, options: SdkCallOptions): Promise; /** * Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide. */ exportImage(input: AWS.EC2.ExportImageRequest, options: SdkCallOptions): Promise; /** * Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range. The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways. */ exportTransitGatewayRoutes(input: AWS.EC2.ExportTransitGatewayRoutesRequest, options: SdkCallOptions): Promise; /** * Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that's used to encrypt the private key. */ getAssociatedEnclaveCertificateIamRoles(input: AWS.EC2.GetAssociatedEnclaveCertificateIamRolesRequest, options: SdkCallOptions): Promise; /** * Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool. */ getAssociatedIpv6PoolCidrs(input: AWS.EC2.GetAssociatedIpv6PoolCidrsRequest, options: SdkCallOptions): Promise; /** * Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage. */ getCapacityReservationUsage(input: AWS.EC2.GetCapacityReservationUsageRequest, options: SdkCallOptions): Promise; /** * Describes the allocations from the specified customer-owned address pool. */ getCoipPoolUsage(input: AWS.EC2.GetCoipPoolUsageRequest, options: SdkCallOptions): Promise; /** * Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors. By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available. You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor. For more information, see Instance console output in the Amazon EC2 User Guide. */ getConsoleOutput(input: AWS.EC2.GetConsoleOutputRequest, options: SdkCallOptions): Promise; /** * Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded. */ getConsoleScreenshot(input: AWS.EC2.GetConsoleScreenshotRequest, options: SdkCallOptions): Promise; /** * Describes the default credit option for CPU usage of a burstable performance instance family. For more information, see Burstable performance instances in the Amazon EC2 User Guide. */ getDefaultCreditSpecification(input: AWS.EC2.GetDefaultCreditSpecificationRequest, options: SdkCallOptions): Promise; /** * Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. */ getEbsDefaultKmsKeyId(input: AWS.EC2.GetEbsDefaultKmsKeyIdRequest, options: SdkCallOptions): Promise; /** * Describes whether EBS encryption by default is enabled for your account in the current Region. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. */ getEbsEncryptionByDefault(input: AWS.EC2.GetEbsEncryptionByDefaultRequest, options: SdkCallOptions): Promise; /** * Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following: Create a table in Athena that maps fields to a custom log format Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis Create a table partitioned between two timestamps in the past Create a set of named queries in Athena that you can use to get started quickly */ getFlowLogsIntegrationTemplate(input: AWS.EC2.GetFlowLogsIntegrationTemplateRequest, options: SdkCallOptions): Promise; /** * Lists the resource groups to which a Capacity Reservation has been added. */ getGroupsForCapacityReservation(input: AWS.EC2.GetGroupsForCapacityReservationRequest, options: SdkCallOptions): Promise; /** * Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased. */ getHostReservationPurchasePreview(input: AWS.EC2.GetHostReservationPurchasePreviewRequest, options: SdkCallOptions): Promise; /** * Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity. When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values. For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. */ getInstanceTypesFromInstanceRequirements(input: AWS.EC2.GetInstanceTypesFromInstanceRequirementsRequest, options: SdkCallOptions): Promise; /** * A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded. When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide. */ getInstanceUefiData(input: AWS.EC2.GetInstanceUefiDataRequest, options: SdkCallOptions): Promise; /** * Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide. */ getIpamAddressHistory(input: AWS.EC2.GetIpamAddressHistoryRequest, options: SdkCallOptions): Promise; /** * Get a list of all the CIDR allocations in an IPAM pool. */ getIpamPoolAllocations(input: AWS.EC2.GetIpamPoolAllocationsRequest, options: SdkCallOptions): Promise; /** * Get the CIDRs provisioned to an IPAM pool. */ getIpamPoolCidrs(input: AWS.EC2.GetIpamPoolCidrsRequest, options: SdkCallOptions): Promise; /** * Get information about the resources in a scope. */ getIpamResourceCidrs(input: AWS.EC2.GetIpamResourceCidrsRequest, options: SdkCallOptions): Promise; /** * Retrieves the configuration data of the specified instance. You can use this data to create a launch template. This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements. */ getLaunchTemplateData(input: AWS.EC2.GetLaunchTemplateDataRequest, options: SdkCallOptions): Promise; /** * Gets information about the resources that are associated with the specified managed prefix list. */ getManagedPrefixListAssociations(input: AWS.EC2.GetManagedPrefixListAssociationsRequest, options: SdkCallOptions): Promise; /** * Gets information about the entries for a specified managed prefix list. */ getManagedPrefixListEntries(input: AWS.EC2.GetManagedPrefixListEntriesRequest, options: SdkCallOptions): Promise; /** * Gets the findings for the specified Network Access Scope analysis. */ getNetworkInsightsAccessScopeAnalysisFindings(input: AWS.EC2.GetNetworkInsightsAccessScopeAnalysisFindingsRequest, options: SdkCallOptions): Promise; /** * Gets the content for the specified Network Access Scope. */ getNetworkInsightsAccessScopeContent(input: AWS.EC2.GetNetworkInsightsAccessScopeContentRequest, options: SdkCallOptions): Promise; /** * Retrieves the encrypted administrator password for a running Windows instance. The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide. For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling. The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. */ getPasswordData(input: AWS.EC2.GetPasswordDataRequest, options: SdkCallOptions): Promise; /** * Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange. */ getReservedInstancesExchangeQuote(input: AWS.EC2.GetReservedInstancesExchangeQuoteRequest, options: SdkCallOptions): Promise; /** * Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide. */ getSerialConsoleAccessStatus(input: AWS.EC2.GetSerialConsoleAccessStatusRequest, options: SdkCallOptions): Promise; /** * Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements. You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes. For more information, see Spot placement score in the Amazon EC2 User Guide. */ getSpotPlacementScores(input: AWS.EC2.GetSpotPlacementScoresRequest, options: SdkCallOptions): Promise; /** * Gets information about the subnet CIDR reservations. */ getSubnetCidrReservations(input: AWS.EC2.GetSubnetCidrReservationsRequest, options: SdkCallOptions): Promise; /** * Lists the route tables to which the specified resource attachment propagates routes. */ getTransitGatewayAttachmentPropagations(input: AWS.EC2.GetTransitGatewayAttachmentPropagationsRequest, options: SdkCallOptions): Promise; /** * Gets information about the associations for the transit gateway multicast domain. */ getTransitGatewayMulticastDomainAssociations(input: AWS.EC2.GetTransitGatewayMulticastDomainAssociationsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the transit gateway policy table associations. */ getTransitGatewayPolicyTableAssociations(input: AWS.EC2.GetTransitGatewayPolicyTableAssociationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of transit gateway policy table entries. */ getTransitGatewayPolicyTableEntries(input: AWS.EC2.GetTransitGatewayPolicyTableEntriesRequest, options: SdkCallOptions): Promise; /** * Gets information about the prefix list references in a specified transit gateway route table. */ getTransitGatewayPrefixListReferences(input: AWS.EC2.GetTransitGatewayPrefixListReferencesRequest, options: SdkCallOptions): Promise; /** * Gets information about the associations for the specified transit gateway route table. */ getTransitGatewayRouteTableAssociations(input: AWS.EC2.GetTransitGatewayRouteTableAssociationsRequest, options: SdkCallOptions): Promise; /** * Gets information about the route table propagations for the specified transit gateway route table. */ getTransitGatewayRouteTablePropagations(input: AWS.EC2.GetTransitGatewayRouteTablePropagationsRequest, options: SdkCallOptions): Promise; /** * Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection. */ getVpnConnectionDeviceSampleConfiguration(input: AWS.EC2.GetVpnConnectionDeviceSampleConfigurationRequest, options: SdkCallOptions): Promise; /** * Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide. */ getVpnConnectionDeviceTypes(input: AWS.EC2.GetVpnConnectionDeviceTypesRequest, options: SdkCallOptions): Promise; /** * Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list. Uploading a client certificate revocation list resets existing client connections. */ importClientVpnClientCertificateRevocationList(input: AWS.EC2.ImportClientVpnClientCertificateRevocationListRequest, options: SdkCallOptions): Promise; /** * Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized. For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide. */ importImage(input: AWS.EC2.ImportImageRequest, options: SdkCallOptions): Promise; /** * Creates an import instance task using metadata from the specified disk image. This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file. For information about the import manifest referenced by this API action, see VM Import Manifest. */ importInstance(input: AWS.EC2.ImportInstanceRequest, options: SdkCallOptions): Promise; /** * Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services. For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide. */ importKeyPair(input: AWS.EC2.ImportKeyPairRequest, options: SdkCallOptions): Promise; /** * Imports a disk into an EBS snapshot. For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide. */ importSnapshot(input: AWS.EC2.ImportSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates an import volume task using metadata from the specified disk image. This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead. This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file. For information about the import manifest referenced by this API action, see VM Import Manifest. */ importVolume(input: AWS.EC2.ImportVolumeRequest, options: SdkCallOptions): Promise; /** * Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide. */ listImagesInRecycleBin(input: AWS.EC2.ListImagesInRecycleBinRequest, options: SdkCallOptions): Promise; /** * Lists one or more snapshots that are currently in the Recycle Bin. */ listSnapshotsInRecycleBin(input: AWS.EC2.ListSnapshotsInRecycleBinRequest, options: SdkCallOptions): Promise; /** * Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications. */ modifyAddressAttribute(input: AWS.EC2.ModifyAddressAttributeRequest, options: SdkCallOptions): Promise; /** * Changes the opt-in status of the Local Zone and Wavelength Zone group for your account. Use DescribeAvailabilityZones to view the value for GroupName. */ modifyAvailabilityZoneGroup(input: AWS.EC2.ModifyAvailabilityZoneGroupRequest, options: SdkCallOptions): Promise; /** * Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. */ modifyCapacityReservation(input: AWS.EC2.ModifyCapacityReservationRequest, options: SdkCallOptions): Promise; /** * Modifies a Capacity Reservation Fleet. When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly. */ modifyCapacityReservationFleet(input: AWS.EC2.ModifyCapacityReservationFleetRequest, options: SdkCallOptions): Promise; /** * Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. */ modifyClientVpnEndpoint(input: AWS.EC2.ModifyClientVpnEndpointRequest, options: SdkCallOptions): Promise; /** * Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option. ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates. For more information, see Burstable performance instances in the Amazon EC2 User Guide. */ modifyDefaultCreditSpecification(input: AWS.EC2.ModifyDefaultCreditSpecificationRequest, options: SdkCallOptions): Promise; /** * Changes the default KMS key for EBS encryption by default for your account in this Region. Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys. If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. */ modifyEbsDefaultKmsKeyId(input: AWS.EC2.ModifyEbsDefaultKmsKeyIdRequest, options: SdkCallOptions): Promise; /** * Modifies the specified EC2 Fleet. You can only modify an EC2 Fleet request of type maintain. While the EC2 Fleet is being modified, it is in the modifying state. To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually. If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0. */ modifyFleet(input: AWS.EC2.ModifyFleetRequest, options: SdkCallOptions): Promise; /** * Modifies the specified attribute of the specified Amazon FPGA Image (AFI). */ modifyFpgaImageAttribute(input: AWS.EC2.ModifyFpgaImageAttributeRequest, options: SdkCallOptions): Promise; /** * Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled. You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only. */ modifyHosts(input: AWS.EC2.ModifyHostsRequest, options: SdkCallOptions): Promise; /** * Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. */ modifyIdFormat(input: AWS.EC2.ModifyIdFormatRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide. This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type. */ modifyIdentityIdFormat(input: AWS.EC2.ModifyIdentityIdFormatRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission. Images with an Amazon Web Services Marketplace product code cannot be made public. To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance. */ modifyImageAttribute(input: AWS.EC2.ModifyImageAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action. To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide. */ modifyInstanceAttribute(input: AWS.EC2.ModifyInstanceAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity. */ modifyInstanceCapacityReservationAttributes(input: AWS.EC2.ModifyInstanceCapacityReservationAttributesRequest, options: SdkCallOptions): Promise; /** * Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited. For more information, see Burstable performance instances in the Amazon EC2 User Guide. */ modifyInstanceCreditSpecification(input: AWS.EC2.ModifyInstanceCreditSpecificationRequest, options: SdkCallOptions): Promise; /** * Modifies the start time for a scheduled Amazon EC2 instance event. */ modifyInstanceEventStartTime(input: AWS.EC2.ModifyInstanceEventStartTimeRequest, options: SdkCallOptions): Promise; /** * Modifies the specified event window. You can define either a set of time ranges or a cron expression when modifying the event window, but not both. To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API. If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide. */ modifyInstanceEventWindow(input: AWS.EC2.ModifyInstanceEventWindowRequest, options: SdkCallOptions): Promise; /** * Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery. */ modifyInstanceMaintenanceOptions(input: AWS.EC2.ModifyInstanceMaintenanceOptionsRequest, options: SdkCallOptions): Promise; /** * Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide. */ modifyInstanceMetadataOptions(input: AWS.EC2.ModifyInstanceMetadataOptionsRequest, options: SdkCallOptions): Promise; /** * Modifies the placement attributes for a specified instance. You can do the following: Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists. Change the Dedicated Host with which an instance is associated. Change the instance tenancy of an instance. Move an instance to or from a placement group. At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request. To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state. */ modifyInstancePlacement(input: AWS.EC2.ModifyInstancePlacementRequest, options: SdkCallOptions): Promise; /** * Modify the configurations of an IPAM. */ modifyIpam(input: AWS.EC2.ModifyIpamRequest, options: SdkCallOptions): Promise; /** * Modify the configurations of an IPAM pool. For more information, see Modify a pool in the Amazon VPC IPAM User Guide. */ modifyIpamPool(input: AWS.EC2.ModifyIpamPoolRequest, options: SdkCallOptions): Promise; /** * Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in. For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide. */ modifyIpamResourceCidr(input: AWS.EC2.ModifyIpamResourceCidrRequest, options: SdkCallOptions): Promise; /** * Modify an IPAM scope. */ modifyIpamScope(input: AWS.EC2.ModifyIpamScopeRequest, options: SdkCallOptions): Promise; /** * Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified. */ modifyLaunchTemplate(input: AWS.EC2.ModifyLaunchTemplateRequest, options: SdkCallOptions): Promise; /** * Modifies the specified local gateway route. */ modifyLocalGatewayRoute(input: AWS.EC2.ModifyLocalGatewayRouteRequest, options: SdkCallOptions): Promise; /** * Modifies the specified managed prefix list. Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version. If you specify a current version number that does not match the true current version number, the request fails. */ modifyManagedPrefixList(input: AWS.EC2.ModifyManagedPrefixListRequest, options: SdkCallOptions): Promise; /** * Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. */ modifyNetworkInterfaceAttribute(input: AWS.EC2.ModifyNetworkInterfaceAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies the options for instance hostnames for the specified instance. */ modifyPrivateDnsNameOptions(input: AWS.EC2.ModifyPrivateDnsNameOptionsRequest, options: SdkCallOptions): Promise; /** * Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ modifyReservedInstances(input: AWS.EC2.ModifyReservedInstancesRequest, options: SdkCallOptions): Promise; /** * Modifies the rules of a security group. */ modifySecurityGroupRules(input: AWS.EC2.ModifySecurityGroupRulesRequest, options: SdkCallOptions): Promise; /** * Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation. Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts. For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide. */ modifySnapshotAttribute(input: AWS.EC2.ModifySnapshotAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide. */ modifySnapshotTier(input: AWS.EC2.ModifySnapshotTierRequest, options: SdkCallOptions): Promise; /** * Modifies the specified Spot Fleet request. You can only modify a Spot Fleet request of type maintain. While the Spot Fleet request is being modified, it is in the modifying state. To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually. If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0. */ modifySpotFleetRequest(input: AWS.EC2.ModifySpotFleetRequestRequest, options: SdkCallOptions): Promise; /** * Modifies a subnet attribute. You can only modify one attribute at a time. Use this action to modify subnets on Amazon Web Services Outposts. To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute. To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex. For more information about Amazon Web Services Outposts, see the following: Outpost servers Outpost racks */ modifySubnetAttribute(input: AWS.EC2.ModifySubnetAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Allows or restricts mirroring network services. By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter. */ modifyTrafficMirrorFilterNetworkServices(input: AWS.EC2.ModifyTrafficMirrorFilterNetworkServicesRequest, options: SdkCallOptions): Promise; /** * Modifies the specified Traffic Mirror rule. DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range. */ modifyTrafficMirrorFilterRule(input: AWS.EC2.ModifyTrafficMirrorFilterRuleRequest, options: SdkCallOptions): Promise; /** * Modifies a Traffic Mirror session. */ modifyTrafficMirrorSession(input: AWS.EC2.ModifyTrafficMirrorSessionRequest, options: SdkCallOptions): Promise; /** * Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified. */ modifyTransitGateway(input: AWS.EC2.ModifyTransitGatewayRequest, options: SdkCallOptions): Promise; /** * Modifies a reference (route) to a prefix list in a specified transit gateway route table. */ modifyTransitGatewayPrefixListReference(input: AWS.EC2.ModifyTransitGatewayPrefixListReferenceRequest, options: SdkCallOptions): Promise; /** * Modifies the specified VPC attachment. */ modifyTransitGatewayVpcAttachment(input: AWS.EC2.ModifyTransitGatewayVpcAttachmentRequest, options: SdkCallOptions): Promise; /** * You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) or Amazon EBS Elastic Volumes (Windows instances). When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or Extend a Windows file system. You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications. With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance. After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period. */ modifyVolume(input: AWS.EC2.ModifyVolumeRequest, options: SdkCallOptions): Promise; /** * Modifies a volume attribute. By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. */ modifyVolumeAttribute(input: AWS.EC2.ModifyVolumeAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies the specified attribute of the specified VPC. */ modifyVpcAttribute(input: AWS.EC2.ModifyVpcAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide. */ modifyVpcEndpoint(input: AWS.EC2.ModifyVpcEndpointRequest, options: SdkCallOptions): Promise; /** * Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. */ modifyVpcEndpointConnectionNotification(input: AWS.EC2.ModifyVpcEndpointConnectionNotificationRequest, options: SdkCallOptions): Promise; /** * Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint. If you set or modify the private DNS name, you must prove that you own the private DNS domain name. */ modifyVpcEndpointServiceConfiguration(input: AWS.EC2.ModifyVpcEndpointServiceConfigurationRequest, options: SdkCallOptions): Promise; /** * Modifies the payer responsibility for your VPC endpoint service. */ modifyVpcEndpointServicePayerResponsibility(input: AWS.EC2.ModifyVpcEndpointServicePayerResponsibilityRequest, options: SdkCallOptions): Promise; /** * Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service. If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved. */ modifyVpcEndpointServicePermissions(input: AWS.EC2.ModifyVpcEndpointServicePermissionsRequest, options: SdkCallOptions): Promise; /** * We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following: Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC. Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC. Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC. If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command. */ modifyVpcPeeringConnectionOptions(input: AWS.EC2.ModifyVpcPeeringConnectionOptionsRequest, options: SdkCallOptions): Promise; /** * Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated. After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide. */ modifyVpcTenancy(input: AWS.EC2.ModifyVpcTenancyRequest, options: SdkCallOptions): Promise; /** * Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available: An existing virtual private gateway to a new virtual private gateway An existing virtual private gateway to a transit gateway An existing transit gateway to a new transit gateway An existing transit gateway to a virtual private gateway Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway. This step is required when you migrate from a virtual private gateway with static routes to a transit gateway. You must delete the static routes before you migrate to the new gateway. Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete. After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide. When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes. If you deleted VPN static routes, you must add the static routes to the transit gateway route table. After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints. */ modifyVpnConnection(input: AWS.EC2.ModifyVpnConnectionRequest, options: SdkCallOptions): Promise; /** * Modifies the connection options for your Site-to-Site VPN connection. When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated. */ modifyVpnConnectionOptions(input: AWS.EC2.ModifyVpnConnectionOptionsRequest, options: SdkCallOptions): Promise; /** * Modifies the VPN tunnel endpoint certificate. */ modifyVpnTunnelCertificate(input: AWS.EC2.ModifyVpnTunnelCertificateRequest, options: SdkCallOptions): Promise; /** * Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide. */ modifyVpnTunnelOptions(input: AWS.EC2.ModifyVpnTunnelOptionsRequest, options: SdkCallOptions): Promise; /** * Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide. To disable detailed monitoring, see UnmonitorInstances. */ monitorInstances(input: AWS.EC2.MonitorInstancesRequest, options: SdkCallOptions): Promise; /** * Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ moveAddressToVpc(input: AWS.EC2.MoveAddressToVpcRequest, options: SdkCallOptions): Promise; /** * Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool. If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM. */ moveByoipCidrToIpam(input: AWS.EC2.MoveByoipCidrToIpamRequest, options: SdkCallOptions): Promise; /** * Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool. */ provisionByoipCidr(input: AWS.EC2.ProvisionByoipCidrRequest, options: SdkCallOptions): Promise; /** * Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it. For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide. */ provisionIpamPoolCidr(input: AWS.EC2.ProvisionIpamPoolCidrRequest, options: SdkCallOptions): Promise; /** * Provision a CIDR to a public IPv4 pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. */ provisionPublicIpv4PoolCidr(input: AWS.EC2.ProvisionPublicIpv4PoolCidrRequest, options: SdkCallOptions): Promise; /** * Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. */ purchaseHostReservation(input: AWS.EC2.PurchaseHostReservationRequest, options: SdkCallOptions): Promise; /** * Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing. Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances. To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time. For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ purchaseReservedInstancesOffering(input: AWS.EC2.PurchaseReservedInstancesOfferingRequest, options: SdkCallOptions): Promise; /** * You can no longer purchase Scheduled Instances. Purchases the Scheduled Instances with the specified schedule. Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period. After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase. */ purchaseScheduledInstances(input: AWS.EC2.PurchaseScheduledInstancesRequest, options: SdkCallOptions): Promise; /** * Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot. For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide. */ rebootInstances(input: AWS.EC2.RebootInstancesRequest, options: SdkCallOptions): Promise<{}>; /** * Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide. For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. We recommend that you always use CreateImage unless you have a specific reason to use RegisterImage. If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. Register a snapshot of a root device volume You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted. For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide. Amazon Web Services Marketplace product codes If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI. Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association: Launch an instance from an existing AMI with that billing product code. Customize the instance. Create an AMI from the instance using CreateImage. If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide. */ registerImage(input: AWS.EC2.RegisterImageRequest, options: SdkCallOptions): Promise; /** * Registers a set of tag keys to include in scheduled event notifications for your resources. To remove tags, use DeregisterInstanceEventNotificationAttributes. */ registerInstanceEventNotificationAttributes(input: AWS.EC2.RegisterInstanceEventNotificationAttributesRequest, options: SdkCallOptions): Promise; /** * Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways. After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group. */ registerTransitGatewayMulticastGroupMembers(input: AWS.EC2.RegisterTransitGatewayMulticastGroupMembersRequest, options: SdkCallOptions): Promise; /** * Registers sources (network interfaces) with the specified transit gateway multicast group. A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways. After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group. */ registerTransitGatewayMulticastGroupSources(input: AWS.EC2.RegisterTransitGatewayMulticastGroupSourcesRequest, options: SdkCallOptions): Promise; /** * Rejects a request to associate cross-account subnets with a transit gateway multicast domain. */ rejectTransitGatewayMulticastDomainAssociations(input: AWS.EC2.RejectTransitGatewayMulticastDomainAssociationsRequest, options: SdkCallOptions): Promise; /** * Rejects a transit gateway peering attachment request. */ rejectTransitGatewayPeeringAttachment(input: AWS.EC2.RejectTransitGatewayPeeringAttachmentRequest, options: SdkCallOptions): Promise; /** * Rejects a request to attach a VPC to a transit gateway. The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request. */ rejectTransitGatewayVpcAttachment(input: AWS.EC2.RejectTransitGatewayVpcAttachmentRequest, options: SdkCallOptions): Promise; /** * Rejects one or more VPC endpoint connection requests to your VPC endpoint service. */ rejectVpcEndpointConnections(input: AWS.EC2.RejectVpcEndpointConnectionsRequest, options: SdkCallOptions): Promise; /** * Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection. */ rejectVpcPeeringConnection(input: AWS.EC2.RejectVpcPeeringConnectionRequest, options: SdkCallOptions): Promise; /** * Releases the specified Elastic IP address. [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. [Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse). After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account. [EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. */ releaseAddress(input: AWS.EC2.ReleaseAddressRequest, options: SdkCallOptions): Promise<{}>; /** * When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released. When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again. Released hosts still appear in a DescribeHosts response. */ releaseHosts(input: AWS.EC2.ReleaseHostsRequest, options: SdkCallOptions): Promise; /** * Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. */ releaseIpamPoolAllocation(input: AWS.EC2.ReleaseIpamPoolAllocationRequest, options: SdkCallOptions): Promise; /** * Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first. Use DescribeIamInstanceProfileAssociations to get the association ID. */ replaceIamInstanceProfileAssociation(input: AWS.EC2.ReplaceIamInstanceProfileAssociationRequest, options: SdkCallOptions): Promise; /** * Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. This is an idempotent operation. */ replaceNetworkAclAssociation(input: AWS.EC2.ReplaceNetworkAclAssociationRequest, options: SdkCallOptions): Promise; /** * Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide. */ replaceNetworkAclEntry(input: AWS.EC2.ReplaceNetworkAclEntryRequest, options: SdkCallOptions): Promise<{}>; /** * Replaces an existing route within a route table in a VPC. You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target. For more information, see Route tables in the Amazon Virtual Private Cloud User Guide. */ replaceRoute(input: AWS.EC2.ReplaceRouteRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide. You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table. */ replaceRouteTableAssociation(input: AWS.EC2.ReplaceRouteTableAssociationRequest, options: SdkCallOptions): Promise; /** * Replaces the specified route in the specified transit gateway route table. */ replaceTransitGatewayRoute(input: AWS.EC2.ReplaceTransitGatewayRouteRequest, options: SdkCallOptions): Promise; /** * Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. */ reportInstanceStatus(input: AWS.EC2.ReportInstanceStatusRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a Spot Fleet request. The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity. You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet. You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported. For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances. We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances. */ requestSpotFleet(input: AWS.EC2.RequestSpotFleetRequest, options: SdkCallOptions): Promise; /** * Creates a Spot Instance request. For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances. We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances. */ requestSpotInstances(input: AWS.EC2.RequestSpotInstancesRequest, options: SdkCallOptions): Promise; /** * Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications. */ resetAddressAttribute(input: AWS.EC2.ResetAddressAttributeRequest, options: SdkCallOptions): Promise; /** * Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS. After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. */ resetEbsDefaultKmsKeyId(input: AWS.EC2.ResetEbsDefaultKmsKeyIdRequest, options: SdkCallOptions): Promise; /** * Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. */ resetFpgaImageAttribute(input: AWS.EC2.ResetFpgaImageAttributeRequest, options: SdkCallOptions): Promise; /** * Resets an attribute of an AMI to its default value. */ resetImageAttribute(input: AWS.EC2.ResetImageAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped. The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide. */ resetInstanceAttribute(input: AWS.EC2.ResetInstanceAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Resets a network interface attribute. You can specify only one attribute at a time. */ resetNetworkInterfaceAttribute(input: AWS.EC2.ResetNetworkInterfaceAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Resets permission settings for the specified snapshot. For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide. */ resetSnapshotAttribute(input: AWS.EC2.ResetSnapshotAttributeRequest, options: SdkCallOptions): Promise<{}>; /** * Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ restoreAddressToClassic(input: AWS.EC2.RestoreAddressToClassicRequest, options: SdkCallOptions): Promise; /** * Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide. */ restoreImageFromRecycleBin(input: AWS.EC2.RestoreImageFromRecycleBinRequest, options: SdkCallOptions): Promise; /** * Restores the entries from a previous version of a managed prefix list to a new version of the prefix list. */ restoreManagedPrefixListVersion(input: AWS.EC2.RestoreManagedPrefixListVersionRequest, options: SdkCallOptions): Promise; /** * Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide. */ restoreSnapshotFromRecycleBin(input: AWS.EC2.RestoreSnapshotFromRecycleBinRequest, options: SdkCallOptions): Promise; /** * Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored. For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide. */ restoreSnapshotTier(input: AWS.EC2.RestoreSnapshotTierRequest, options: SdkCallOptions): Promise; /** * Removes an ingress authorization rule from a Client VPN endpoint. */ revokeClientVpnIngress(input: AWS.EC2.RevokeClientVpnIngressRequest, options: SdkCallOptions): Promise; /** * [VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic. You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule. [Default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked. Amazon Web Services recommends that you describe the security group to verify that the rules were removed. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. */ revokeSecurityGroupEgress(input: AWS.EC2.RevokeSecurityGroupEgressRequest, options: SdkCallOptions): Promise; /** * Removes the specified inbound (ingress) rules from a security group. You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule. [EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked. Amazon Web Services recommends that you describe the security group to verify that the rules were removed. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide. */ revokeSecurityGroupIngress(input: AWS.EC2.RevokeSecurityGroupIngressRequest, options: SdkCallOptions): Promise; /** * Launches the specified number of instances using an AMI for which you have permissions. You can specify a number of options, or leave the default options. The following rules apply: [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request. [EC2-Classic] If don't specify an Availability Zone, we choose one for you. Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC. [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet. Not all instance types support IPv6 addresses. For more information, see Instance types. If you don't specify a security group ID, we use the default security group. For more information, see Security groups. If any of the AMIs have a product code attached for which the user has not subscribed, the request fails. You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters. To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances. An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources. Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs. For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance. We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide. */ runInstances(input: AWS.EC2.RunInstancesRequest, options: SdkCallOptions): Promise; /** * Launches the specified Scheduled Instances. Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances. You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide. */ runScheduledInstances(input: AWS.EC2.RunScheduledInstancesRequest, options: SdkCallOptions): Promise; /** * Searches for routes in the specified local gateway route table. */ searchLocalGatewayRoutes(input: AWS.EC2.SearchLocalGatewayRoutesRequest, options: SdkCallOptions): Promise; /** * Searches one or more transit gateway multicast groups and returns the group membership information. */ searchTransitGatewayMulticastGroups(input: AWS.EC2.SearchTransitGatewayMulticastGroupsRequest, options: SdkCallOptions): Promise; /** * Searches for routes in the specified transit gateway route table. */ searchTransitGatewayRoutes(input: AWS.EC2.SearchTransitGatewayRoutesRequest, options: SdkCallOptions): Promise; /** * Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI). In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace. Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks. For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances). */ sendDiagnosticInterrupt(input: AWS.EC2.SendDiagnosticInterruptRequest, options: SdkCallOptions): Promise<{}>; /** * Starts an Amazon EBS-backed instance that you've previously stopped. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. If you attempt to start a T3 instance with host tenancy and the unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated. For more information, see Stop and start your instance in the Amazon EC2 User Guide. */ startInstances(input: AWS.EC2.StartInstancesRequest, options: SdkCallOptions): Promise; /** * Starts analyzing the specified Network Access Scope. */ startNetworkInsightsAccessScopeAnalysis(input: AWS.EC2.StartNetworkInsightsAccessScopeAnalysisRequest, options: SdkCallOptions): Promise; /** * Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path. */ startNetworkInsightsAnalysis(input: AWS.EC2.StartNetworkInsightsAnalysisRequest, options: SdkCallOptions): Promise; /** * Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service. The service provider must successfully perform the verification before the consumer can use the name to access the service. Before the service provider runs this command, they must add a record to the DNS server. */ startVpcEndpointServicePrivateDnsVerification(input: AWS.EC2.StartVpcEndpointServicePrivateDnsVerificationRequest, options: SdkCallOptions): Promise; /** * Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide. You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide. We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide. When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs. Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide. When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide. */ stopInstances(input: AWS.EC2.StopInstancesRequest, options: SdkCallOptions): Promise; /** * Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user. */ terminateClientVpnConnections(input: AWS.EC2.TerminateClientVpnConnectionsRequest, options: SdkCallOptions): Promise; /** * Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated. If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results: The specified instances that are in the same Availability Zone as the protected instance are not terminated. The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated. For example, say you have the following instances: Instance A: us-east-1a; Not protected Instance B: us-east-1a; Not protected Instance C: us-east-1b; Protected Instance D: us-east-1b; not protected If you attempt to terminate all of these instances in the same request, the request reports failure with the following results: Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection. Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection. Terminated instances remain visible after termination (for approximately one hour). By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide. For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide. */ terminateInstances(input: AWS.EC2.TerminateInstancesRequest, options: SdkCallOptions): Promise; /** * Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. */ unassignIpv6Addresses(input: AWS.EC2.UnassignIpv6AddressesRequest, options: SdkCallOptions): Promise; /** * Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface. */ unassignPrivateIpAddresses(input: AWS.EC2.UnassignPrivateIpAddressesRequest, options: SdkCallOptions): Promise<{}>; /** * Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide. */ unmonitorInstances(input: AWS.EC2.UnmonitorInstancesRequest, options: SdkCallOptions): Promise; /** * [VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request. */ updateSecurityGroupRuleDescriptionsEgress(input: AWS.EC2.UpdateSecurityGroupRuleDescriptionsEgressRequest, options: SdkCallOptions): Promise; /** * Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request. */ updateSecurityGroupRuleDescriptionsIngress(input: AWS.EC2.UpdateSecurityGroupRuleDescriptionsIngressRequest, options: SdkCallOptions): Promise; /** * Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays. */ withdrawByoipCidr(input: AWS.EC2.WithdrawByoipCidrRequest, options: SdkCallOptions): Promise; } export interface EC2InstanceConnect { /** * Pushes an SSH public key to the specified EC2 instance for use by the specified user. The key remains for 60 seconds. For more information, see Connect to your Linux instance using EC2 Instance Connect in the Amazon EC2 User Guide. */ sendSSHPublicKey(input: AWS.EC2InstanceConnect.SendSSHPublicKeyRequest, options: SdkCallOptions): Promise; /** * Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see EC2 Serial Console in the Amazon EC2 User Guide. */ sendSerialConsoleSSHPublicKey(input: AWS.EC2InstanceConnect.SendSerialConsoleSSHPublicKeyRequest, options: SdkCallOptions): Promise; } export interface ECR { /** * Checks the availability of one or more image layers in a repository. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ batchCheckLayerAvailability(input: AWS.ECR.BatchCheckLayerAvailabilityRequest, options: SdkCallOptions): Promise; /** * Deletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request. */ batchDeleteImage(input: AWS.ECR.BatchDeleteImageRequest, options: SdkCallOptions): Promise; /** * Gets detailed information for an image. Images are specified with either an imageTag or imageDigest. When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest. */ batchGetImage(input: AWS.ECR.BatchGetImageRequest, options: SdkCallOptions): Promise; /** * Gets the scanning configuration for one or more repositories. */ batchGetRepositoryScanningConfiguration(input: AWS.ECR.BatchGetRepositoryScanningConfigurationRequest, options: SdkCallOptions): Promise; /** * Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ completeLayerUpload(input: AWS.ECR.CompleteLayerUploadRequest, options: SdkCallOptions): Promise; /** * Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry. */ createPullThroughCacheRule(input: AWS.ECR.CreatePullThroughCacheRuleRequest, options: SdkCallOptions): Promise; /** * Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide. */ createRepository(input: AWS.ECR.CreateRepositoryRequest, options: SdkCallOptions): Promise; /** * Deletes the lifecycle policy associated with the specified repository. */ deleteLifecyclePolicy(input: AWS.ECR.DeleteLifecyclePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a pull through cache rule. */ deletePullThroughCacheRule(input: AWS.ECR.DeletePullThroughCacheRuleRequest, options: SdkCallOptions): Promise; /** * Deletes the registry permissions policy. */ deleteRegistryPolicy(input: AWS.ECR.DeleteRegistryPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository. */ deleteRepository(input: AWS.ECR.DeleteRepositoryRequest, options: SdkCallOptions): Promise; /** * Deletes the repository policy associated with the specified repository. */ deleteRepositoryPolicy(input: AWS.ECR.DeleteRepositoryPolicyRequest, options: SdkCallOptions): Promise; /** * Returns the replication status for a specified image. */ describeImageReplicationStatus(input: AWS.ECR.DescribeImageReplicationStatusRequest, options: SdkCallOptions): Promise; /** * Returns the scan findings for the specified image. */ describeImageScanFindings(input: AWS.ECR.DescribeImageScanFindingsRequest, options: SdkCallOptions): Promise; /** * Returns metadata about the images in a repository. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages. */ describeImages(input: AWS.ECR.DescribeImagesRequest, options: SdkCallOptions): Promise; /** * Returns the pull through cache rules for a registry. */ describePullThroughCacheRules(input: AWS.ECR.DescribePullThroughCacheRulesRequest, options: SdkCallOptions): Promise; /** * Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action. */ describeRegistry(input: AWS.ECR.DescribeRegistryRequest, options: SdkCallOptions): Promise; /** * Describes image repositories in a registry. */ describeRepositories(input: AWS.ECR.DescribeRepositoriesRequest, options: SdkCallOptions): Promise; /** * Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The CLI offers an get-login-password command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide. */ getAuthorizationToken(input: AWS.ECR.GetAuthorizationTokenRequest, options: SdkCallOptions): Promise; /** * Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ getDownloadUrlForLayer(input: AWS.ECR.GetDownloadUrlForLayerRequest, options: SdkCallOptions): Promise; /** * Retrieves the lifecycle policy for the specified repository. */ getLifecyclePolicy(input: AWS.ECR.GetLifecyclePolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves the results of the lifecycle policy preview request for the specified repository. */ getLifecyclePolicyPreview(input: AWS.ECR.GetLifecyclePolicyPreviewRequest, options: SdkCallOptions): Promise; /** * Retrieves the permissions policy for a registry. */ getRegistryPolicy(input: AWS.ECR.GetRegistryPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves the scanning configuration for a registry. */ getRegistryScanningConfiguration(input: AWS.ECR.GetRegistryScanningConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the repository policy for the specified repository. */ getRepositoryPolicy(input: AWS.ECR.GetRepositoryPolicyRequest, options: SdkCallOptions): Promise; /** * Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ initiateLayerUpload(input: AWS.ECR.InitiateLayerUploadRequest, options: SdkCallOptions): Promise; /** * Lists all the image IDs for the specified repository. You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository. */ listImages(input: AWS.ECR.ListImagesRequest, options: SdkCallOptions): Promise; /** * List the tags for an Amazon ECR resource. */ listTagsForResource(input: AWS.ECR.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ putImage(input: AWS.ECR.PutImageRequest, options: SdkCallOptions): Promise; /** * The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration. Updates the image scanning configuration for the specified repository. */ putImageScanningConfiguration(input: AWS.ECR.PutImageScanningConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide. */ putImageTagMutability(input: AWS.ECR.PutImageTagMutabilityRequest, options: SdkCallOptions): Promise; /** * Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template. */ putLifecyclePolicy(input: AWS.ECR.PutLifecyclePolicyRequest, options: SdkCallOptions): Promise; /** * Creates or updates the permissions policy for your registry. A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide. */ putRegistryPolicy(input: AWS.ECR.PutRegistryPolicyRequest, options: SdkCallOptions): Promise; /** * Creates or updates the scanning configuration for your private registry. */ putRegistryScanningConfiguration(input: AWS.ECR.PutRegistryScanningConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide. When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy. */ putReplicationConfiguration(input: AWS.ECR.PutReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide. */ setRepositoryPolicy(input: AWS.ECR.SetRepositoryPolicyRequest, options: SdkCallOptions): Promise; /** * Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide. */ startImageScan(input: AWS.ECR.StartImageScanRequest, options: SdkCallOptions): Promise; /** * Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository. */ startLifecyclePolicyPreview(input: AWS.ECR.StartLifecyclePolicyPreviewRequest, options: SdkCallOptions): Promise; /** * Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters. */ tagResource(input: AWS.ECR.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes specified tags from a resource. */ untagResource(input: AWS.ECR.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ uploadLayerPart(input: AWS.ECR.UploadLayerPartRequest, options: SdkCallOptions): Promise; } export interface ECRPUBLIC { /** * Checks the availability of one or more image layers within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ batchCheckLayerAvailability(input: AWS.ECRPUBLIC.BatchCheckLayerAvailabilityRequest, options: SdkCallOptions): Promise; /** * Deletes a list of specified images within a repository in a public registry. Images are specified with either an imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request. */ batchDeleteImage(input: AWS.ECRPUBLIC.BatchDeleteImageRequest, options: SdkCallOptions): Promise; /** * Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ completeLayerUpload(input: AWS.ECRPUBLIC.CompleteLayerUploadRequest, options: SdkCallOptions): Promise; /** * Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide. */ createRepository(input: AWS.ECRPUBLIC.CreateRepositoryRequest, options: SdkCallOptions): Promise; /** * Deletes a repository in a public registry. If the repository contains images, you must either delete all images in the repository or use the force option which deletes all images on your behalf before deleting the repository. */ deleteRepository(input: AWS.ECRPUBLIC.DeleteRepositoryRequest, options: SdkCallOptions): Promise; /** * Deletes the repository policy associated with the specified repository. */ deleteRepositoryPolicy(input: AWS.ECRPUBLIC.DeleteRepositoryPolicyRequest, options: SdkCallOptions): Promise; /** * Returns the image tag details for a repository in a public registry. */ describeImageTags(input: AWS.ECRPUBLIC.DescribeImageTagsRequest, options: SdkCallOptions): Promise; /** * Returns metadata about the images in a repository in a public registry. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages. */ describeImages(input: AWS.ECRPUBLIC.DescribeImagesRequest, options: SdkCallOptions): Promise; /** * Returns details for a public registry. */ describeRegistries(input: AWS.ECRPUBLIC.DescribeRegistriesRequest, options: SdkCallOptions): Promise; /** * Describes repositories in a public registry. */ describeRepositories(input: AWS.ECRPUBLIC.DescribeRepositoriesRequest, options: SdkCallOptions): Promise; /** * Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions. */ getAuthorizationToken(input: AWS.ECRPUBLIC.GetAuthorizationTokenRequest, options: SdkCallOptions): Promise; /** * Retrieves catalog metadata for a public registry. */ getRegistryCatalogData(input: AWS.ECRPUBLIC.GetRegistryCatalogDataRequest, options: SdkCallOptions): Promise; /** * Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery. */ getRepositoryCatalogData(input: AWS.ECRPUBLIC.GetRepositoryCatalogDataRequest, options: SdkCallOptions): Promise; /** * Retrieves the repository policy for the specified repository. */ getRepositoryPolicy(input: AWS.ECRPUBLIC.GetRepositoryPolicyRequest, options: SdkCallOptions): Promise; /** * Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ initiateLayerUpload(input: AWS.ECRPUBLIC.InitiateLayerUploadRequest, options: SdkCallOptions): Promise; /** * List the tags for an Amazon ECR Public resource. */ listTagsForResource(input: AWS.ECRPUBLIC.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ putImage(input: AWS.ECRPUBLIC.PutImageRequest, options: SdkCallOptions): Promise; /** * Create or updates the catalog data for a public registry. */ putRegistryCatalogData(input: AWS.ECRPUBLIC.PutRegistryCatalogDataRequest, options: SdkCallOptions): Promise; /** * Creates or updates the catalog data for a repository in a public registry. */ putRepositoryCatalogData(input: AWS.ECRPUBLIC.PutRepositoryCatalogDataRequest, options: SdkCallOptions): Promise; /** * Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide. */ setRepositoryPolicy(input: AWS.ECRPUBLIC.SetRepositoryPolicyRequest, options: SdkCallOptions): Promise; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. */ tagResource(input: AWS.ECRPUBLIC.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes specified tags from a resource. */ untagResource(input: AWS.ECRPUBLIC.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images. */ uploadLayerPart(input: AWS.ECRPUBLIC.UploadLayerPartRequest, options: SdkCallOptions): Promise; } export interface ECS { /** * Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling. Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports. */ createCapacityProvider(input: AWS.ECS.CreateCapacityProviderRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action. When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the IAM user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide. */ createCluster(input: AWS.ECS.CreateClusterRequest, options: SdkCallOptions): Promise; /** * Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action. In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide. Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer. There are two service scheduler strategies available: REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide. DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide. You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%. If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%. If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%. If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service. When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide. When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide. */ createService(input: AWS.ECS.CreateServiceRequest, options: SdkCallOptions): Promise; /** * Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide. */ createTaskSet(input: AWS.ECS.CreateTaskSetRequest, options: SdkCallOptions): Promise; /** * Disables an account setting for a specified IAM user, IAM role, or the root user for an account. */ deleteAccountSetting(input: AWS.ECS.DeleteAccountSettingRequest, options: SdkCallOptions): Promise; /** * Deletes one or more custom attributes from an Amazon ECS resource. */ deleteAttributes(input: AWS.ECS.DeleteAttributesRequest, options: SdkCallOptions): Promise; /** * Deletes the specified capacity provider. The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster. Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster. */ deleteCapacityProvider(input: AWS.ECS.DeleteCapacityProviderRequest, options: SdkCallOptions): Promise; /** * Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance. */ deleteCluster(input: AWS.ECS.DeleteClusterRequest, options: SdkCallOptions): Promise; /** * Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can't delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService. When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error. If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error. */ deleteService(input: AWS.ECS.DeleteServiceRequest, options: SdkCallOptions): Promise; /** * Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide. */ deleteTaskSet(input: AWS.ECS.DeleteTaskSetRequest, options: SdkCallOptions): Promise; /** * Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources. Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated). */ deregisterContainerInstance(input: AWS.ECS.DeregisterContainerInstanceRequest, options: SdkCallOptions): Promise; /** * Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. You can't use an INACTIVE task definition to run new tasks or create new services, and you can't update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect. At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services. */ deregisterTaskDefinition(input: AWS.ECS.DeregisterTaskDefinitionRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your capacity providers. */ describeCapacityProviders(input: AWS.ECS.DescribeCapacityProvidersRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your clusters. */ describeClusters(input: AWS.ECS.DescribeClustersRequest, options: SdkCallOptions): Promise; /** * Describes one or more container instances. Returns metadata about each container instance requested. */ describeContainerInstances(input: AWS.ECS.DescribeContainerInstancesRequest, options: SdkCallOptions): Promise; /** * Describes the specified services running in your cluster. */ describeServices(input: AWS.ECS.DescribeServicesRequest, options: SdkCallOptions): Promise; /** * Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family. You can only describe INACTIVE task definitions while an active task or service references them. */ describeTaskDefinition(input: AWS.ECS.DescribeTaskDefinitionRequest, options: SdkCallOptions): Promise; /** * Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. */ describeTaskSets(input: AWS.ECS.DescribeTaskSetsRequest, options: SdkCallOptions): Promise; /** * Describes a specified task or tasks. Currently, stopped tasks appear in the returned results for at least one hour. */ describeTasks(input: AWS.ECS.DescribeTasksRequest, options: SdkCallOptions): Promise; /** * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Returns an endpoint for the Amazon ECS agent to poll for updates. */ discoverPollEndpoint(input: AWS.ECS.DiscoverPollEndpointRequest, options: SdkCallOptions): Promise; /** * Runs a command remotely on a container within a task. If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you recevie an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value. */ executeCommand(input: AWS.ECS.ExecuteCommandRequest, options: SdkCallOptions): Promise; /** * Lists the account settings for a specified principal. */ listAccountSettings(input: AWS.ECS.ListAccountSettingsRequest, options: SdkCallOptions): Promise; /** * Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux). */ listAttributes(input: AWS.ECS.ListAttributesRequest, options: SdkCallOptions): Promise; /** * Returns a list of existing clusters. */ listClusters(input: AWS.ECS.ListClustersRequest, options: SdkCallOptions): Promise; /** * Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. */ listContainerInstances(input: AWS.ECS.ListContainerInstancesRequest, options: SdkCallOptions): Promise; /** * Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy. */ listServices(input: AWS.ECS.ListServicesRequest, options: SdkCallOptions): Promise; /** * List the tags for an Amazon ECS resource. */ listTagsForResource(input: AWS.ECS.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions. You can filter out task definition families that don't contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter. */ listTaskDefinitionFamilies(input: AWS.ECS.ListTaskDefinitionFamiliesRequest, options: SdkCallOptions): Promise; /** * Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter. */ listTaskDefinitions(input: AWS.ECS.ListTaskDefinitionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task. Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour. */ listTasks(input: AWS.ECS.ListTasksRequest, options: SdkCallOptions): Promise; /** * Modifies an account setting. Account settings are set on a per-Region basis. If you change the account setting for the root user, the default settings for all of the IAM users and roles that no individual account setting was specified are reset for. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide. When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the IAM user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide. When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide. */ putAccountSetting(input: AWS.ECS.PutAccountSettingRequest, options: SdkCallOptions): Promise; /** * Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis. */ putAccountSettingDefault(input: AWS.ECS.PutAccountSettingDefaultRequest, options: SdkCallOptions): Promise; /** * Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide. */ putAttributes(input: AWS.ECS.PutAttributesRequest, options: SdkCallOptions): Promise; /** * Modifies the available capacity providers and the default capacity provider strategy for a cluster. You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks. When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy. */ putClusterCapacityProviders(input: AWS.ECS.PutClusterCapacityProvidersRequest, options: SdkCallOptions): Promise; /** * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on. */ registerContainerInstance(input: AWS.ECS.RegisterContainerInstanceRequest, options: SdkCallOptions): Promise; /** * Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the IAM policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. */ registerTaskDefinition(input: AWS.ECS.RegisterTaskDefinitionRequest, options: SdkCallOptions): Promise; /** * Starts a new task using the specified task definition. You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command. To manage eventual consistency, you can do the following: Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time. Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time. */ runTask(input: AWS.ECS.RunTaskRequest, options: SdkCallOptions): Promise; /** * Starts a new task from the specified task definition on the specified container instance or instances. Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. */ startTask(input: AWS.ECS.StartTaskRequest, options: SdkCallOptions): Promise; /** * Stops a running task. Any tags associated with the task will be deleted. When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent. The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. */ stopTask(input: AWS.ECS.StopTaskRequest, options: SdkCallOptions): Promise; /** * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that an attachment changed states. */ submitAttachmentStateChanges(input: AWS.ECS.SubmitAttachmentStateChangesRequest, options: SdkCallOptions): Promise; /** * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that a container changed states. */ submitContainerStateChange(input: AWS.ECS.SubmitContainerStateChangeRequest, options: SdkCallOptions): Promise; /** * This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Sent to acknowledge that a task changed states. */ submitTaskStateChange(input: AWS.ECS.SubmitTaskStateChangeRequest, options: SdkCallOptions): Promise; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. */ tagResource(input: AWS.ECS.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes specified tags from a resource. */ untagResource(input: AWS.ECS.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Modifies the parameters for a capacity provider. */ updateCapacityProvider(input: AWS.ECS.UpdateCapacityProviderRequest, options: SdkCallOptions): Promise; /** * Updates the cluster. */ updateCluster(input: AWS.ECS.UpdateClusterRequest, options: SdkCallOptions): Promise; /** * Modifies the settings to use for a cluster. */ updateClusterSettings(input: AWS.ECS.UpdateClusterSettingsRequest, options: SdkCallOptions): Promise; /** * Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system. The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide. The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide. */ updateContainerAgent(input: AWS.ECS.UpdateContainerAgentRequest, options: SdkCallOptions): Promise; /** * Modifies the status of an Amazon ECS container instance. Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size. A container instance can't be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received. When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately. Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService. If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer. The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped. Any PENDING or RUNNING tasks that do not belong to a service aren't affected. You must wait for them to finish or stop them manually. A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks. When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again. */ updateContainerInstancesState(input: AWS.ECS.UpdateContainerInstancesStateRequest, options: SdkCallOptions): Promise; /** * Modifies the parameters of a service. For services using the rolling update (ECS) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration. For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference. For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet. You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter. If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy. If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you don't need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start. You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy. If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer. The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout. After this, SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent. When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic. Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes. By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy. Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination. Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service. You must have a service-linked role when you update any of the following service properties. If you specified a custom IAM role when you created the service, Amazon ECS automatically replaces the roleARN associated with the service with the ARN of your service-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide. loadBalancers, serviceRegistries */ updateService(input: AWS.ECS.UpdateServiceRequest, options: SdkCallOptions): Promise; /** * Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. */ updateServicePrimaryTaskSet(input: AWS.ECS.UpdateServicePrimaryTaskSetRequest, options: SdkCallOptions): Promise; /** * Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. */ updateTaskSet(input: AWS.ECS.UpdateTaskSetRequest, options: SdkCallOptions): Promise; } export interface EFS { /** * Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access points. This operation requires permissions for the elasticfilesystem:CreateAccessPoint action. */ createAccessPoint(input: AWS.EFS.CreateAccessPointRequest, options: SdkCallOptions): Promise; /** * Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token. The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error. For more information, see Creating a file system in the Amazon EFS User Guide. The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state. This operation accepts an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes. You can set the throughput mode for the file system using the ThroughputMode parameter. After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works. This operation requires permissions for the elasticfilesystem:CreateFileSystem action. */ createFileSystem(input: AWS.EFS.CreateFileSystemRequest, options: SdkCallOptions): Promise; /** * Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. You can create only one mount target for an EFS file system using One Zone storage classes. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target. For more information, see Amazon EFS: How it Works. To create a mount target for a file system, the file system's lifecycle state must be available. For more information, see DescribeFileSystems. In the request, provide the following: The file system ID for which you are creating the mount target. A subnet ID, which determines the following: The VPC in which Amazon EFS creates the mount target The Availability Zone in which Amazon EFS creates the mount target The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request) After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview. Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements: Must belong to the same VPC as the subnets of the existing mount targets Must not be in the same Availability Zone as any of the subnets of the existing mount targets If the request satisfies the requirements, Amazon EFS does the following: Creates a new mount target in the specified subnet. Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails. The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state. We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:CreateMountTarget This operation also requires permissions for the following Amazon EC2 actions: ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface */ createMountTarget(input: AWS.EFS.CreateMountTargetRequest, options: SdkCallOptions): Promise; /** * Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following: Source file system - An existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration. Destination file system configuration - The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. The destination file system configuration consists of the following properties: Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions that Amazon EFS is available in, except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe (Milan), and Middle East (Bahrain). Availability Zone - If you want the destination file system to use EFS One Zone availability and durability, you must specify the Availability Zone to create the file system in. For more information about EFS storage classes, see Amazon EFS storage classes in the Amazon EFS User Guide. Encryption - All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used. After the file system is created, you cannot change the KMS key. The following properties are set by default: Performance mode - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed. Throughput mode - The destination file system uses the Bursting Throughput mode by default. After the file system is created, you can modify the throughput mode. The following properties are turned off by default: Lifecycle management - EFS lifecycle management and EFS Intelligent-Tiering are not enabled on the destination file system. After the destination file system is created, you can enable EFS lifecycle management and EFS Intelligent-Tiering. Automatic backups - Automatic daily backups not enabled on the destination file system. After the file system is created, you can change this setting. For more information, see Amazon EFS replication in the Amazon EFS User Guide. */ createReplicationConfiguration(input: AWS.EFS.CreateReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS resources, use the API action. Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation. This operation requires permission for the elasticfilesystem:CreateTags action. */ createTags(input: AWS.EFS.CreateTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection. This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action. */ deleteAccessPoint(input: AWS.EFS.DeleteAccessPointRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system. You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system. You cannot delete a file system that is part of an EFS Replication configuration. You need to delete the replication configuration first. You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget. The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error. This operation requires permissions for the elasticfilesystem:DeleteFileSystem action. */ deleteFileSystem(input: AWS.EFS.DeleteFileSystemRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS. This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action. */ deleteFileSystemPolicy(input: AWS.EFS.DeleteFileSystemPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified mount target. This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system. The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface: ec2:DeleteNetworkInterface */ deleteMountTarget(input: AWS.EFS.DeleteMountTargetRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing replication configuration. To delete a replication configuration, you must make the request from the Amazon Web Services Region in which the destination file system is located. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system is no longer read-only. You can write to the destination file system after its status becomes Writeable. */ deleteReplicationConfiguration(input: AWS.EFS.DeleteReplicationConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS resources, use the API action. Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag restrictions in the Billing and Cost Management User Guide. This operation requires permissions for the elasticfilesystem:DeleteTags action. */ deleteTags(input: AWS.EFS.DeleteTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action. */ describeAccessPoints(input: AWS.EFS.DescribeAccessPointsRequest, options: SdkCallOptions): Promise; /** * Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region. For more information, see Managing Amazon EFS resource IDs. */ describeAccountPreferences(input: AWS.EFS.DescribeAccountPreferencesRequest, options: SdkCallOptions): Promise; /** * Returns the backup policy for the specified EFS file system. */ describeBackupPolicy(input: AWS.EFS.DescribeBackupPolicyRequest, options: SdkCallOptions): Promise; /** * Returns the FileSystemPolicy for the specified EFS file system. This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action. */ describeFileSystemPolicy(input: AWS.EFS.DescribeFileSystemPolicyRequest, options: SdkCallOptions): Promise; /** * Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker. To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker. The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified. This operation requires permissions for the elasticfilesystem:DescribeFileSystems action. */ describeFileSystems(input: AWS.EFS.DescribeFileSystemsRequest, options: SdkCallOptions): Promise; /** * Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response. When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass has a value of AFTER_1_ACCESS. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation. */ describeLifecycleConfiguration(input: AWS.EFS.DescribeLifecycleConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. This operation requires permissions for the following actions: elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system. ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface. */ describeMountTargetSecurityGroups(input: AWS.EFS.DescribeMountTargetSecurityGroupsRequest, options: SdkCallOptions): Promise; /** * Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified. This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId. */ describeMountTargets(input: AWS.EFS.DescribeMountTargetsRequest, options: SdkCallOptions): Promise; /** * Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved. */ describeReplicationConfigurations(input: AWS.EFS.DescribeReplicationConfigurationsRequest, options: SdkCallOptions): Promise; /** * DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource API action. Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. This operation requires permissions for the elasticfilesystem:DescribeTags action. */ describeTags(input: AWS.EFS.DescribeTagsRequest, options: SdkCallOptions): Promise; /** * Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action. */ listTagsForResource(input: AWS.EFS.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Modifies the set of security groups in effect for a mount target. When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. The operation requires permissions for the following actions: elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system. ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface. */ modifyMountTargetSecurityGroups(input: AWS.EFS.ModifyMountTargetSecurityGroupsRequest, options: SdkCallOptions): Promise<{}>; /** * Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs. Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources. */ putAccountPreferences(input: AWS.EFS.PutAccountPreferencesRequest, options: SdkCallOptions): Promise; /** * Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system. */ putBackupPolicy(input: AWS.EFS.PutBackupPolicyRequest, options: SdkCallOptions): Promise; /** * Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy. EFS file system policies have a 20,000 character limit. This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action. */ putFileSystemPolicy(input: AWS.EFS.PutFileSystemPolicyRequest, options: SdkCallOptions): Promise; /** * Use this action to manage EFS lifecycle management and intelligent tiering. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following: EFS Lifecycle management - When Amazon EFS automatically transitions files in a file system into the lower-cost Infrequent Access (IA) storage class. To enable EFS Lifecycle management, set the value of TransitionToIA to one of the available options. EFS Intelligent tiering - When Amazon EFS automatically transitions files from IA back into the file system's primary storage class (Standard or One Zone Standard. To enable EFS Intelligent Tiering, set the value of TransitionToPrimaryStorageClass to AFTER_1_ACCESS. For more information, see EFS Lifecycle Management. Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and turns off lifecycle management and intelligent tiering for the file system. In the request, specify the following: The ID for the file system for which you are enabling, disabling, or modifying lifecycle management and intelligent tiering. A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved into IA storage, and when they are moved back to Standard storage. Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information. This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system. */ putLifecycleConfiguration(input: AWS.EFS.PutLifecycleConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation. This operation requires permissions for the elasticfilesystem:TagResource action. */ tagResource(input: AWS.EFS.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation. This operation requires permissions for the elasticfilesystem:UntagResource action. */ untagResource(input: AWS.EFS.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the throughput mode or the amount of provisioned throughput of an existing file system. */ updateFileSystem(input: AWS.EFS.UpdateFileSystemRequest, options: SdkCallOptions): Promise; } export interface EKS { /** * Associate encryption configuration to an existing cluster. You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters. */ associateEncryptionConfig(input: AWS.EKS.AssociateEncryptionConfigRequest, options: SdkCallOptions): Promise; /** * Associate an identity provider configuration to a cluster. If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes roles and clusterroles to assign permissions to the roles, and then bind the roles to the identities using Kubernetes rolebindings and clusterrolebindings. For more information see Using RBAC Authorization in the Kubernetes documentation. */ associateIdentityProviderConfig(input: AWS.EKS.AssociateIdentityProviderConfigRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon EKS add-on. Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. Amazon EKS add-ons require clusters running version 1.18 or later because Amazon EKS add-ons rely on the Server-side Apply Kubernetes feature, which is only available in Kubernetes 1.18 and later. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide. */ createAddon(input: AWS.EKS.CreateAddonRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon EKS control plane. The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances. The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support kubectl exec, logs, and proxy data flows). Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster. In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide. */ createCluster(input: AWS.EKS.CreateClusterRequest, options: SdkCallOptions): Promise; /** * Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate. The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate. When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the kubelet that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide. Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating. If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster. For more information, see Fargate Profile in the Amazon EKS User Guide. */ createFargateProfile(input: AWS.EKS.CreateFargateProfileRequest, options: SdkCallOptions): Promise; /** * Creates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support. An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide. */ createNodegroup(input: AWS.EKS.CreateNodegroupRequest, options: SdkCallOptions): Promise; /** * Delete an Amazon EKS add-on. When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API. */ deleteAddon(input: AWS.EKS.DeleteAddonRequest, options: SdkCallOptions): Promise; /** * Deletes the Amazon EKS cluster control plane. If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide. If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile. */ deleteCluster(input: AWS.EKS.DeleteClusterRequest, options: SdkCallOptions): Promise; /** * Deletes an Fargate profile. When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state. Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster. */ deleteFargateProfile(input: AWS.EKS.DeleteFargateProfileRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon EKS node group for a cluster. */ deleteNodegroup(input: AWS.EKS.DeleteNodegroupRequest, options: SdkCallOptions): Promise; /** * Deregisters a connected cluster to remove it from the Amazon EKS control plane. */ deregisterCluster(input: AWS.EKS.DeregisterClusterRequest, options: SdkCallOptions): Promise; /** * Describes an Amazon EKS add-on. */ describeAddon(input: AWS.EKS.DescribeAddonRequest, options: SdkCallOptions): Promise; /** * Describes the Kubernetes versions that the add-on can be used with. */ describeAddonVersions(input: AWS.EKS.DescribeAddonVersionsRequest, options: SdkCallOptions): Promise; /** * Returns descriptive information about an Amazon EKS cluster. The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS. The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state. */ describeCluster(input: AWS.EKS.DescribeClusterRequest, options: SdkCallOptions): Promise; /** * Returns descriptive information about an Fargate profile. */ describeFargateProfile(input: AWS.EKS.DescribeFargateProfileRequest, options: SdkCallOptions): Promise; /** * Returns descriptive information about an identity provider configuration. */ describeIdentityProviderConfig(input: AWS.EKS.DescribeIdentityProviderConfigRequest, options: SdkCallOptions): Promise; /** * Returns descriptive information about an Amazon EKS node group. */ describeNodegroup(input: AWS.EKS.DescribeNodegroupRequest, options: SdkCallOptions): Promise; /** * Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on. When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure. */ describeUpdate(input: AWS.EKS.DescribeUpdateRequest, options: SdkCallOptions): Promise; /** * Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with Amazon Web Services IAM users. */ disassociateIdentityProviderConfig(input: AWS.EKS.DisassociateIdentityProviderConfigRequest, options: SdkCallOptions): Promise; /** * Lists the available add-ons. */ listAddons(input: AWS.EKS.ListAddonsRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region. */ listClusters(input: AWS.EKS.ListClustersRequest, options: SdkCallOptions): Promise; /** * Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region. */ listFargateProfiles(input: AWS.EKS.ListFargateProfilesRequest, options: SdkCallOptions): Promise; /** * A list of identity provider configurations. */ listIdentityProviderConfigs(input: AWS.EKS.ListIdentityProviderConfigsRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed. */ listNodegroups(input: AWS.EKS.ListNodegroupsRequest, options: SdkCallOptions): Promise; /** * List the tags for an Amazon EKS resource. */ listTagsForResource(input: AWS.EKS.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region. */ listUpdates(input: AWS.EKS.ListUpdatesRequest, options: SdkCallOptions): Promise; /** * Connects a Kubernetes cluster to the Amazon EKS control plane. Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes. Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane. Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility. After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster. */ registerCluster(input: AWS.EKS.RegisterClusterRequest, options: SdkCallOptions): Promise; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and nodes associated with the cluster. */ tagResource(input: AWS.EKS.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes specified tags from a resource. */ untagResource(input: AWS.EKS.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon EKS add-on. */ updateAddon(input: AWS.EKS.UpdateAddonRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation. You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing. You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide . You can't update the subnets or security group IDs for an existing cluster. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active. */ updateClusterConfig(input: AWS.EKS.UpdateClusterConfigRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active. If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version. */ updateClusterVersion(input: AWS.EKS.UpdateClusterVersionRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration. */ updateNodegroupConfig(input: AWS.EKS.UpdateNodegroupConfigRequest, options: SdkCallOptions): Promise; /** * Updates the Kubernetes version or AMI version of an Amazon EKS managed node group. You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template. If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide. You cannot roll back a node group to an earlier Kubernetes version or AMI version. When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue. */ updateNodegroupVersion(input: AWS.EKS.UpdateNodegroupVersionRequest, options: SdkCallOptions): Promise; } export interface ElastiCache { /** * A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide. */ addTagsToResource(input: AWS.ElastiCache.AddTagsToResourceMessage, options: SdkCallOptions): Promise; /** * Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region. */ authorizeCacheSecurityGroupIngress(input: AWS.ElastiCache.AuthorizeCacheSecurityGroupIngressMessage, options: SdkCallOptions): Promise; /** * Apply the service update. For more information on service updates and applying them, see Applying Service Updates. */ batchApplyUpdateAction(input: AWS.ElastiCache.BatchApplyUpdateActionMessage, options: SdkCallOptions): Promise; /** * Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates. */ batchStopUpdateAction(input: AWS.ElastiCache.BatchStopUpdateActionMessage, options: SdkCallOptions): Promise; /** * Complete the migration of data. */ completeMigration(input: AWS.ElastiCache.CompleteMigrationMessage, options: SdkCallOptions): Promise; /** * Makes a copy of an existing snapshot. This operation is valid for Redis only. Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control. You could receive the following error messages. Error Messages Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions. Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName. Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. */ copySnapshot(input: AWS.ElastiCache.CopySnapshotMessage, options: SdkCallOptions): Promise; /** * Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters. */ createCacheCluster(input: AWS.ElastiCache.CreateCacheClusterMessage, options: SdkCallOptions): Promise; /** * Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see: ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter Groups in the ElastiCache User Guide. */ createCacheParameterGroup(input: AWS.ElastiCache.CreateCacheParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup. */ createCacheSecurityGroup(input: AWS.ElastiCache.CreateCacheSecurityGroupMessage, options: SdkCallOptions): Promise; /** * Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). */ createCacheSubnetGroup(input: AWS.ElastiCache.CreateCacheSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore. The GlobalReplicationGroupIdSuffix is the name of the Global datastore. The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster. */ createGlobalReplicationGroup(input: AWS.ElastiCache.CreateGlobalReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore. A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster. To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type. When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide. This operation is valid for Redis only. */ createReplicationGroup(input: AWS.ElastiCache.CreateReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only. */ createSnapshot(input: AWS.ElastiCache.CreateSnapshotMessage, options: SdkCallOptions): Promise; /** * For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC). */ createUser(input: AWS.ElastiCache.CreateUserMessage, options: SdkCallOptions): Promise; /** * For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) */ createUserGroup(input: AWS.ElastiCache.CreateUserGroupMessage, options: SdkCallOptions): Promise; /** * Decreases the number of node groups in a Global datastore */ decreaseNodeGroupsInGlobalReplicationGroup(input: AWS.ElastiCache.DecreaseNodeGroupsInGlobalReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. */ decreaseReplicaCount(input: AWS.ElastiCache.DecreaseReplicaCountMessage, options: SdkCallOptions): Promise; /** * Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation is not valid for: Redis (cluster mode enabled) clusters Redis (cluster mode disabled) clusters A cluster that is the last read replica of a replication group A cluster that is the primary node of a replication group A node group (shard) that has Multi-AZ mode enabled A cluster from a Redis (cluster mode enabled) replication group A cluster that is not in the available state */ deleteCacheCluster(input: AWS.ElastiCache.DeleteCacheClusterMessage, options: SdkCallOptions): Promise; /** * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account. */ deleteCacheParameterGroup(input: AWS.ElastiCache.DeleteCacheParameterGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters. */ deleteCacheSecurityGroup(input: AWS.ElastiCache.DeleteCacheSecurityGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a cache subnet group. You cannot delete a default cache subnet group or one that is associated with any clusters. */ deleteCacheSubnetGroup(input: AWS.ElastiCache.DeleteCacheSubnetGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deleting a Global datastore is a two-step process: First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore. Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true. Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. */ deleteGlobalReplicationGroup(input: AWS.ElastiCache.DeleteGlobalReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. This operation is valid for Redis only. */ deleteReplicationGroup(input: AWS.ElastiCache.DeleteReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Redis only. */ deleteSnapshot(input: AWS.ElastiCache.DeleteSnapshotMessage, options: SdkCallOptions): Promise; /** * For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC). */ deleteUser(input: AWS.ElastiCache.DeleteUserMessage, options: SdkCallOptions): Promise; /** * For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC). */ deleteUserGroup(input: AWS.ElastiCache.DeleteUserGroupMessage, options: SdkCallOptions): Promise; /** * Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed. */ describeCacheClusters(input: AWS.ElastiCache.DescribeCacheClustersMessage, options: SdkCallOptions): Promise; /** * Returns a list of the available cache engines and their versions. */ describeCacheEngineVersions(input: AWS.ElastiCache.DescribeCacheEngineVersionsMessage, options: SdkCallOptions): Promise; /** * Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group. */ describeCacheParameterGroups(input: AWS.ElastiCache.DescribeCacheParameterGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the detailed parameter list for a particular cache parameter group. */ describeCacheParameters(input: AWS.ElastiCache.DescribeCacheParametersMessage, options: SdkCallOptions): Promise; /** * Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup */ describeCacheSecurityGroups(input: AWS.ElastiCache.DescribeCacheSecurityGroupsMessage, options: SdkCallOptions): Promise; /** * Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default. */ describeCacheSubnetGroups(input: AWS.ElastiCache.DescribeCacheSubnetGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the default engine and system parameter information for the specified cache engine. */ describeEngineDefaultParameters(input: AWS.ElastiCache.DescribeEngineDefaultParametersMessage, options: SdkCallOptions): Promise; /** * Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. */ describeEvents(input: AWS.ElastiCache.DescribeEventsMessage, options: SdkCallOptions): Promise; /** * Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. */ describeGlobalReplicationGroups(input: AWS.ElastiCache.DescribeGlobalReplicationGroupsMessage, options: SdkCallOptions): Promise; /** * Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. This operation is valid for Redis only. */ describeReplicationGroups(input: AWS.ElastiCache.DescribeReplicationGroupsMessage, options: SdkCallOptions): Promise; /** * Returns information about reserved cache nodes for this account, or about a specified reserved cache node. */ describeReservedCacheNodes(input: AWS.ElastiCache.DescribeReservedCacheNodesMessage, options: SdkCallOptions): Promise; /** * Lists available reserved cache node offerings. */ describeReservedCacheNodesOfferings(input: AWS.ElastiCache.DescribeReservedCacheNodesOfferingsMessage, options: SdkCallOptions): Promise; /** * Returns details of the service updates */ describeServiceUpdates(input: AWS.ElastiCache.DescribeServiceUpdatesMessage, options: SdkCallOptions): Promise; /** * Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Redis only. */ describeSnapshots(input: AWS.ElastiCache.DescribeSnapshotsMessage, options: SdkCallOptions): Promise; /** * Returns details of the update actions */ describeUpdateActions(input: AWS.ElastiCache.DescribeUpdateActionsMessage, options: SdkCallOptions): Promise; /** * Returns a list of user groups. */ describeUserGroups(input: AWS.ElastiCache.DescribeUserGroupsMessage, options: SdkCallOptions): Promise; /** * Returns a list of users. */ describeUsers(input: AWS.ElastiCache.DescribeUsersMessage, options: SdkCallOptions): Promise; /** * Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region. */ disassociateGlobalReplicationGroup(input: AWS.ElastiCache.DisassociateGlobalReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary. */ failoverGlobalReplicationGroup(input: AWS.ElastiCache.FailoverGlobalReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Increase the number of node groups in the Global datastore */ increaseNodeGroupsInGlobalReplicationGroup(input: AWS.ElastiCache.IncreaseNodeGroupsInGlobalReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. */ increaseReplicaCount(input: AWS.ElastiCache.IncreaseReplicaCountMessage, options: SdkCallOptions): Promise; /** * Lists all available node types that you can scale your Redis cluster's or replication group's current node type. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation. */ listAllowedNodeTypeModifications(input: AWS.ElastiCache.ListAllowedNodeTypeModificationsMessage, options: SdkCallOptions): Promise; /** * Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. If the cluster is not in the available state, ListTagsForResource returns an error. */ listTagsForResource(input: AWS.ElastiCache.ListTagsForResourceMessage, options: SdkCallOptions): Promise; /** * Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values. */ modifyCacheCluster(input: AWS.ElastiCache.ModifyCacheClusterMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. */ modifyCacheParameterGroup(input: AWS.ElastiCache.ModifyCacheParameterGroupMessage, options: SdkCallOptions): Promise; /** * Modifies an existing cache subnet group. */ modifyCacheSubnetGroup(input: AWS.ElastiCache.ModifyCacheSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Modifies the settings for a Global datastore. */ modifyGlobalReplicationGroup(input: AWS.ElastiCache.ModifyGlobalReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Modifies the settings for a replication group. Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only. */ modifyReplicationGroup(input: AWS.ElastiCache.ModifyReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards. */ modifyReplicationGroupShardConfiguration(input: AWS.ElastiCache.ModifyReplicationGroupShardConfigurationMessage, options: SdkCallOptions): Promise; /** * Changes user password(s) and/or access string. */ modifyUser(input: AWS.ElastiCache.ModifyUserMessage, options: SdkCallOptions): Promise; /** * Changes the list of users that belong to the user group. */ modifyUserGroup(input: AWS.ElastiCache.ModifyUserGroupMessage, options: SdkCallOptions): Promise; /** * Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached. */ purchaseReservedCacheNodesOffering(input: AWS.ElastiCache.PurchaseReservedCacheNodesOfferingMessage, options: SdkCallOptions): Promise; /** * Redistribute slots to ensure uniform distribution across existing shards in the cluster. */ rebalanceSlotsInGlobalReplicationGroup(input: AWS.ElastiCache.RebalanceSlotsInGlobalReplicationGroupMessage, options: SdkCallOptions): Promise; /** * Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process. */ rebootCacheCluster(input: AWS.ElastiCache.RebootCacheClusterMessage, options: SdkCallOptions): Promise; /** * Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. */ removeTagsFromResource(input: AWS.ElastiCache.RemoveTagsFromResourceMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters. */ resetCacheParameterGroup(input: AWS.ElastiCache.ResetCacheParameterGroupMessage, options: SdkCallOptions): Promise; /** * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized. */ revokeCacheSecurityGroupIngress(input: AWS.ElastiCache.RevokeCacheSecurityGroupIngressMessage, options: SdkCallOptions): Promise; /** * Start the migration of data. */ startMigration(input: AWS.ElastiCache.StartMigrationMessage, options: SdkCallOptions): Promise; /** * Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console). This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API. Note the following A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period. If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently. If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made. To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group <node-group-id> Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ in the ElastiCache User Guide. */ testFailover(input: AWS.ElastiCache.TestFailoverMessage, options: SdkCallOptions): Promise; } export interface ElasticBeanstalk { /** * Cancels in-progress environment configuration update or application version deployment. */ abortEnvironmentUpdate(input: AWS.ElasticBeanstalk.AbortEnvironmentUpdateMessage, options: SdkCallOptions): Promise<{}>; /** * Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions. */ applyEnvironmentManagedAction(input: AWS.ElasticBeanstalk.ApplyEnvironmentManagedActionRequest, options: SdkCallOptions): Promise; /** * Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide. */ associateEnvironmentOperationsRole(input: AWS.ElasticBeanstalk.AssociateEnvironmentOperationsRoleMessage, options: SdkCallOptions): Promise<{}>; /** * Checks if the specified CNAME is available. */ checkDNSAvailability(input: AWS.ElasticBeanstalk.CheckDNSAvailabilityMessage, options: SdkCallOptions): Promise; /** * Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details. */ composeEnvironments(input: AWS.ElasticBeanstalk.ComposeEnvironmentsMessage, options: SdkCallOptions): Promise; /** * Creates an application that has one configuration template named default and no application versions. */ createApplication(input: AWS.ElasticBeanstalk.CreateApplicationMessage, options: SdkCallOptions): Promise; /** * Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows: Specify a commit in an AWS CodeCommit repository with SourceBuildInformation. Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration. Specify a source bundle in S3 with SourceBundle Omit both SourceBuildInformation and SourceBundle to use the default sample application. After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version. */ createApplicationVersion(input: AWS.ElasticBeanstalk.CreateApplicationVersionMessage, options: SdkCallOptions): Promise; /** * Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings. Templates aren't associated with any environment. The EnvironmentName response element is always null. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks */ createConfigurationTemplate(input: AWS.ElasticBeanstalk.CreateConfigurationTemplateMessage, options: SdkCallOptions): Promise; /** * Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration. */ createEnvironment(input: AWS.ElasticBeanstalk.CreateEnvironmentMessage, options: SdkCallOptions): Promise; /** * Create a new version of your custom platform. */ createPlatformVersion(input: AWS.ElasticBeanstalk.CreatePlatformVersionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment. */ deleteApplication(input: AWS.ElasticBeanstalk.DeleteApplicationMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment. */ deleteApplicationVersion(input: AWS.ElasticBeanstalk.DeleteApplicationVersionMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified configuration template. When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment. */ deleteConfigurationTemplate(input: AWS.ElasticBeanstalk.DeleteConfigurationTemplateMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes the draft configuration associated with the running environment. Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action. */ deleteEnvironmentConfiguration(input: AWS.ElasticBeanstalk.DeleteEnvironmentConfigurationMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified version of a custom platform. */ deletePlatformVersion(input: AWS.ElasticBeanstalk.DeletePlatformVersionRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of application versions. */ describeApplicationVersions(input: AWS.ElasticBeanstalk.DescribeApplicationVersionsMessage, options: SdkCallOptions): Promise; /** * Returns the descriptions of existing applications. */ describeApplications(input: AWS.ElasticBeanstalk.DescribeApplicationsMessage, options: SdkCallOptions): Promise; /** * Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed. */ describeConfigurationOptions(input: AWS.ElasticBeanstalk.DescribeConfigurationOptionsMessage, options: SdkCallOptions): Promise; /** * Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment. When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. Related Topics DeleteEnvironmentConfiguration */ describeConfigurationSettings(input: AWS.ElasticBeanstalk.DescribeConfigurationSettingsMessage, options: SdkCallOptions): Promise; /** * Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. */ describeEnvironmentHealth(input: AWS.ElasticBeanstalk.DescribeEnvironmentHealthRequest, options: SdkCallOptions): Promise; /** * Lists an environment's completed and failed managed actions. */ describeEnvironmentManagedActionHistory(input: AWS.ElasticBeanstalk.DescribeEnvironmentManagedActionHistoryRequest, options: SdkCallOptions): Promise; /** * Lists an environment's upcoming and in-progress managed actions. */ describeEnvironmentManagedActions(input: AWS.ElasticBeanstalk.DescribeEnvironmentManagedActionsRequest, options: SdkCallOptions): Promise; /** * Returns AWS resources for this environment. */ describeEnvironmentResources(input: AWS.ElasticBeanstalk.DescribeEnvironmentResourcesMessage, options: SdkCallOptions): Promise; /** * Returns descriptions for existing environments. */ describeEnvironments(input: AWS.ElasticBeanstalk.DescribeEnvironmentsMessage, options: SdkCallOptions): Promise; /** * Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken. */ describeEvents(input: AWS.ElasticBeanstalk.DescribeEventsMessage, options: SdkCallOptions): Promise; /** * Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting. */ describeInstancesHealth(input: AWS.ElasticBeanstalk.DescribeInstancesHealthRequest, options: SdkCallOptions): Promise; /** * Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary. */ describePlatformVersion(input: AWS.ElasticBeanstalk.DescribePlatformVersionRequest, options: SdkCallOptions): Promise; /** * Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide. */ disassociateEnvironmentOperationsRole(input: AWS.ElasticBeanstalk.DisassociateEnvironmentOperationsRoleMessage, options: SdkCallOptions): Promise<{}>; /** * Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch. For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary. */ listPlatformBranches(input: AWS.ElasticBeanstalk.ListPlatformBranchesRequest, options: SdkCallOptions): Promise; /** * Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary. */ listPlatformVersions(input: AWS.ElasticBeanstalk.ListPlatformVersionsRequest, options: SdkCallOptions): Promise; /** * Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources. */ listTagsForResource(input: AWS.ElasticBeanstalk.ListTagsForResourceMessage, options: SdkCallOptions): Promise; /** * Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart. */ rebuildEnvironment(input: AWS.ElasticBeanstalk.RebuildEnvironmentMessage, options: SdkCallOptions): Promise<{}>; /** * Initiates a request to compile the specified type of information of the deployed environment. Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs. Use RetrieveEnvironmentInfo to obtain the set of logs. Related Topics RetrieveEnvironmentInfo */ requestEnvironmentInfo(input: AWS.ElasticBeanstalk.RequestEnvironmentInfoMessage, options: SdkCallOptions): Promise<{}>; /** * Causes the environment to restart the application container server running on each Amazon EC2 instance. */ restartAppServer(input: AWS.ElasticBeanstalk.RestartAppServerMessage, options: SdkCallOptions): Promise<{}>; /** * Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfo */ retrieveEnvironmentInfo(input: AWS.ElasticBeanstalk.RetrieveEnvironmentInfoMessage, options: SdkCallOptions): Promise; /** * Swaps the CNAMEs of two environments. */ swapEnvironmentCNAMEs(input: AWS.ElasticBeanstalk.SwapEnvironmentCNAMEsMessage, options: SdkCallOptions): Promise<{}>; /** * Terminates the specified environment. */ terminateEnvironment(input: AWS.ElasticBeanstalk.TerminateEnvironmentMessage, options: SdkCallOptions): Promise; /** * Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string. */ updateApplication(input: AWS.ElasticBeanstalk.UpdateApplicationMessage, options: SdkCallOptions): Promise; /** * Modifies lifecycle settings for an application. */ updateApplicationResourceLifecycle(input: AWS.ElasticBeanstalk.UpdateApplicationResourceLifecycleMessage, options: SdkCallOptions): Promise; /** * Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string. */ updateApplicationVersion(input: AWS.ElasticBeanstalk.UpdateApplicationVersionMessage, options: SdkCallOptions): Promise; /** * Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics DescribeConfigurationOptions */ updateConfigurationTemplate(input: AWS.ElasticBeanstalk.UpdateConfigurationTemplateMessage, options: SdkCallOptions): Promise; /** * Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment. Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error. When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values. */ updateEnvironment(input: AWS.ElasticBeanstalk.UpdateEnvironmentMessage, options: SdkCallOptions): Promise; /** * Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources. If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name: elasticbeanstalk:AddTags Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter. elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter. For details about creating a custom user policy, see Creating a Custom User Policy. */ updateTagsForResource(input: AWS.ElasticBeanstalk.UpdateTagsForResourceMessage, options: SdkCallOptions): Promise<{}>; /** * Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option values. */ validateConfigurationSettings(input: AWS.ElasticBeanstalk.ValidateConfigurationSettingsMessage, options: SdkCallOptions): Promise; } export interface ElasticInference { /** * Describes the locations in which a given accelerator type or set of types is present in a given region. */ describeAcceleratorOfferings(input: AWS.ElasticInference.DescribeAcceleratorOfferingsRequest, options: SdkCallOptions): Promise; /** * Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput. */ describeAcceleratorTypes(input: AWS.ElasticInference.DescribeAcceleratorTypesRequest, options: SdkCallOptions): Promise; /** * Describes information over a provided set of accelerators belonging to an account. */ describeAccelerators(input: AWS.ElasticInference.DescribeAcceleratorsRequest, options: SdkCallOptions): Promise; /** * Returns all tags of an Elastic Inference Accelerator. */ listTagsForResource(input: AWS.ElasticInference.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to an Elastic Inference Accelerator. */ tagResource(input: AWS.ElasticInference.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from an Elastic Inference Accelerator. */ untagResource(input: AWS.ElasticInference.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface ElasticTranscoder { /** * The CancelJob operation cancels an unfinished job. You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline. */ cancelJob(input: AWS.ElasticTranscoder.CancelJobRequest, options: SdkCallOptions): Promise; /** * When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). */ createJob(input: AWS.ElasticTranscoder.CreateJobRequest, options: SdkCallOptions): Promise; /** * The CreatePipeline operation creates a pipeline with settings that you specify. */ createPipeline(input: AWS.ElasticTranscoder.CreatePipelineRequest, options: SdkCallOptions): Promise; /** * The CreatePreset operation creates a preset with settings that you specify. Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces. Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services. */ createPreset(input: AWS.ElasticTranscoder.CreatePresetRequest, options: SdkCallOptions): Promise; /** * The DeletePipeline operation removes a pipeline. You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error. */ deletePipeline(input: AWS.ElasticTranscoder.DeletePipelineRequest, options: SdkCallOptions): Promise; /** * The DeletePreset operation removes a preset that you've added in an AWS region. You can't delete the default presets that are included with Elastic Transcoder. */ deletePreset(input: AWS.ElasticTranscoder.DeletePresetRequest, options: SdkCallOptions): Promise; /** * The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. */ listJobsByPipeline(input: AWS.ElasticTranscoder.ListJobsByPipelineRequest, options: SdkCallOptions): Promise; /** * The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. */ listJobsByStatus(input: AWS.ElasticTranscoder.ListJobsByStatusRequest, options: SdkCallOptions): Promise; /** * The ListPipelines operation gets a list of the pipelines associated with the current AWS account. */ listPipelines(input: AWS.ElasticTranscoder.ListPipelinesRequest, options: SdkCallOptions): Promise; /** * The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. */ listPresets(input: AWS.ElasticTranscoder.ListPresetsRequest, options: SdkCallOptions): Promise; /** * The ReadJob operation returns detailed information about a job. */ readJob(input: AWS.ElasticTranscoder.ReadJobRequest, options: SdkCallOptions): Promise; /** * The ReadPipeline operation gets detailed information about a pipeline. */ readPipeline(input: AWS.ElasticTranscoder.ReadPipelineRequest, options: SdkCallOptions): Promise; /** * The ReadPreset operation gets detailed information about a preset. */ readPreset(input: AWS.ElasticTranscoder.ReadPresetRequest, options: SdkCallOptions): Promise; /** * The TestRole operation tests the IAM role used to create the pipeline. The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify. */ testRole(input: AWS.ElasticTranscoder.TestRoleRequest, options: SdkCallOptions): Promise; /** * Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. */ updatePipeline(input: AWS.ElasticTranscoder.UpdatePipelineRequest, options: SdkCallOptions): Promise; /** * With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. */ updatePipelineNotifications(input: AWS.ElasticTranscoder.UpdatePipelineNotificationsRequest, options: SdkCallOptions): Promise; /** * The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request. */ updatePipelineStatus(input: AWS.ElasticTranscoder.UpdatePipelineStatusRequest, options: SdkCallOptions): Promise; } export interface ELB { /** * Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value. For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide. */ addTags(input: AWS.ELB.AddTagsInput, options: SdkCallOptions): Promise; /** * Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups. For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancers Guide. */ applySecurityGroupsToLoadBalancer(input: AWS.ELB.ApplySecurityGroupsToLoadBalancerInput, options: SdkCallOptions): Promise; /** * Adds one or more subnets to the set of configured subnets for the specified load balancer. The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancers Guide. */ attachLoadBalancerToSubnets(input: AWS.ELB.AttachLoadBalancerToSubnetsInput, options: SdkCallOptions): Promise; /** * Specifies the health check settings to use when evaluating the health state of your EC2 instances. For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide. */ configureHealthCheck(input: AWS.ELB.ConfigureHealthCheckInput, options: SdkCallOptions): Promise; /** * Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners. This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie. If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued. For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide. */ createAppCookieStickinessPolicy(input: AWS.ELB.CreateAppCookieStickinessPolicyInput, options: SdkCallOptions): Promise; /** * Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm. A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration. For more information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide. */ createLBCookieStickinessPolicy(input: AWS.ELB.CreateLBCookieStickinessPolicyInput, options: SdkCallOptions): Promise; /** * Creates a Classic Load Balancer. You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide. */ createLoadBalancer(input: AWS.ELB.CreateAccessPointInput, options: SdkCallOptions): Promise; /** * Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener. For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide. */ createLoadBalancerListeners(input: AWS.ELB.CreateLoadBalancerListenerInput, options: SdkCallOptions): Promise; /** * Creates a policy with the specified attributes for the specified load balancer. Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type. */ createLoadBalancerPolicy(input: AWS.ELB.CreateLoadBalancerPolicyInput, options: SdkCallOptions): Promise; /** * Deletes the specified load balancer. If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances. If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds. */ deleteLoadBalancer(input: AWS.ELB.DeleteAccessPointInput, options: SdkCallOptions): Promise; /** * Deletes the specified listeners from the specified load balancer. */ deleteLoadBalancerListeners(input: AWS.ELB.DeleteLoadBalancerListenerInput, options: SdkCallOptions): Promise; /** * Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners. */ deleteLoadBalancerPolicy(input: AWS.ELB.DeleteLoadBalancerPolicyInput, options: SdkCallOptions): Promise; /** * Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer. You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer. For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide. */ deregisterInstancesFromLoadBalancer(input: AWS.ELB.DeregisterEndPointsInput, options: SdkCallOptions): Promise; /** * Describes the current Elastic Load Balancing resource limits for your AWS account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide. */ describeAccountLimits(input: AWS.ELB.DescribeAccountLimitsInput, options: SdkCallOptions): Promise; /** * Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned. */ describeInstanceHealth(input: AWS.ELB.DescribeEndPointStateInput, options: SdkCallOptions): Promise; /** * Describes the attributes for the specified load balancer. */ describeLoadBalancerAttributes(input: AWS.ELB.DescribeLoadBalancerAttributesInput, options: SdkCallOptions): Promise; /** * Describes the specified policies. If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix. */ describeLoadBalancerPolicies(input: AWS.ELB.DescribeLoadBalancerPoliciesInput, options: SdkCallOptions): Promise; /** * Describes the specified load balancer policy types or all load balancer policy types. The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances. You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy. */ describeLoadBalancerPolicyTypes(input: AWS.ELB.DescribeLoadBalancerPolicyTypesInput, options: SdkCallOptions): Promise; /** * Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. */ describeLoadBalancers(input: AWS.ELB.DescribeAccessPointsInput, options: SdkCallOptions): Promise; /** * Describes the tags associated with the specified load balancers. */ describeTags(input: AWS.ELB.DescribeTagsInput, options: SdkCallOptions): Promise; /** * Removes the specified subnets from the set of configured subnets for the load balancer. After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets. */ detachLoadBalancerFromSubnets(input: AWS.ELB.DetachLoadBalancerFromSubnetsInput, options: SdkCallOptions): Promise; /** * Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC. For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets. There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide. */ disableAvailabilityZonesForLoadBalancer(input: AWS.ELB.RemoveAvailabilityZonesInput, options: SdkCallOptions): Promise; /** * Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC. For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets. The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide. */ enableAvailabilityZonesForLoadBalancer(input: AWS.ELB.AddAvailabilityZonesInput, options: SdkCallOptions): Promise; /** * Modifies the attributes of the specified load balancer. You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer. For more information, see the following in the Classic Load Balancers Guide: Cross-Zone Load Balancing Connection Draining Access Logs Idle Connection Timeout */ modifyLoadBalancerAttributes(input: AWS.ELB.ModifyLoadBalancerAttributesInput, options: SdkCallOptions): Promise; /** * Adds the specified instances to the specified load balancer. The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC. Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth. After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer. For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide. */ registerInstancesWithLoadBalancer(input: AWS.ELB.RegisterEndPointsInput, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified load balancer. */ removeTags(input: AWS.ELB.RemoveTagsInput, options: SdkCallOptions): Promise; /** * Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port. For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide. */ setLoadBalancerListenerSSLCertificate(input: AWS.ELB.SetLoadBalancerListenerSSLCertificateInput, options: SdkCallOptions): Promise; /** * Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies. Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable. You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance. For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide. */ setLoadBalancerPoliciesForBackendServer(input: AWS.ELB.SetLoadBalancerPoliciesForBackendServerInput, options: SdkCallOptions): Promise; /** * Replaces the current set of policies for the specified load balancer port with the specified set of policies. To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer. For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide. */ setLoadBalancerPoliciesOfListener(input: AWS.ELB.SetLoadBalancerPoliciesOfListenerInput, options: SdkCallOptions): Promise; } export interface ELBv2 { /** * Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener. If the certificate in already in the certificate list, the call is successful but the certificate is not added again. For more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the Network Load Balancers Guide. */ addListenerCertificates(input: AWS.ELBv2.AddListenerCertificatesInput, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value. */ addTags(input: AWS.ELBv2.AddTagsInput, options: SdkCallOptions): Promise; /** * Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Listeners for your Application Load Balancers Listeners for your Network Load Balancers Listeners for your Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds. */ createListener(input: AWS.ELBv2.CreateListenerInput, options: SdkCallOptions): Promise; /** * Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Application Load Balancers Network Load Balancers Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds. */ createLoadBalancer(input: AWS.ELBv2.CreateLoadBalancerInput, options: SdkCallOptions): Promise; /** * Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide. */ createRule(input: AWS.ELBv2.CreateRuleInput, options: SdkCallOptions): Promise; /** * Creates a target group. For more information, see the following: Target groups for your Application Load Balancers Target groups for your Network Load Balancers Target groups for your Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds. */ createTargetGroup(input: AWS.ELBv2.CreateTargetGroupInput, options: SdkCallOptions): Promise; /** * Deletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached. */ deleteListener(input: AWS.ELBv2.DeleteListenerInput, options: SdkCallOptions): Promise; /** * Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners. You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds. Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them. */ deleteLoadBalancer(input: AWS.ELBv2.DeleteLoadBalancerInput, options: SdkCallOptions): Promise; /** * Deletes the specified rule. You can't delete the default rule. */ deleteRule(input: AWS.ELBv2.DeleteRuleInput, options: SdkCallOptions): Promise; /** * Deletes the specified target group. You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them. */ deleteTargetGroup(input: AWS.ELBv2.DeleteTargetGroupInput, options: SdkCallOptions): Promise; /** * Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer. */ deregisterTargets(input: AWS.ELBv2.DeregisterTargetsInput, options: SdkCallOptions): Promise; /** * Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account. For more information, see the following: Quotas for your Application Load Balancers Quotas for your Network Load Balancers Quotas for your Gateway Load Balancers */ describeAccountLimits(input: AWS.ELBv2.DescribeAccountLimitsInput, options: SdkCallOptions): Promise; /** * Describes the default certificate and the certificate list for the specified HTTPS or TLS listener. If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false). For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide. */ describeListenerCertificates(input: AWS.ELBv2.DescribeListenerCertificatesInput, options: SdkCallOptions): Promise; /** * Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners. */ describeListeners(input: AWS.ELBv2.DescribeListenersInput, options: SdkCallOptions): Promise; /** * Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Load balancer attributes in the Application Load Balancers Guide Load balancer attributes in the Network Load Balancers Guide Load balancer attributes in the Gateway Load Balancers Guide */ describeLoadBalancerAttributes(input: AWS.ELBv2.DescribeLoadBalancerAttributesInput, options: SdkCallOptions): Promise; /** * Describes the specified load balancers or all of your load balancers. */ describeLoadBalancers(input: AWS.ELBv2.DescribeLoadBalancersInput, options: SdkCallOptions): Promise; /** * Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules. */ describeRules(input: AWS.ELBv2.DescribeRulesInput, options: SdkCallOptions): Promise; /** * Describes the specified policies or all policies used for SSL negotiation. For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide. */ describeSSLPolicies(input: AWS.ELBv2.DescribeSSLPoliciesInput, options: SdkCallOptions): Promise; /** * Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules. */ describeTags(input: AWS.ELBv2.DescribeTagsInput, options: SdkCallOptions): Promise; /** * Describes the attributes for the specified target group. For more information, see the following: Target group attributes in the Application Load Balancers Guide Target group attributes in the Network Load Balancers Guide Target group attributes in the Gateway Load Balancers Guide */ describeTargetGroupAttributes(input: AWS.ELBv2.DescribeTargetGroupAttributesInput, options: SdkCallOptions): Promise; /** * Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups. */ describeTargetGroups(input: AWS.ELBv2.DescribeTargetGroupsInput, options: SdkCallOptions): Promise; /** * Describes the health of the specified targets or all of your targets. */ describeTargetHealth(input: AWS.ELBv2.DescribeTargetHealthInput, options: SdkCallOptions): Promise; /** * Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged. Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties. To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action. */ modifyListener(input: AWS.ELBv2.ModifyListenerInput, options: SdkCallOptions): Promise; /** * Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values. */ modifyLoadBalancerAttributes(input: AWS.ELBv2.ModifyLoadBalancerAttributesInput, options: SdkCallOptions): Promise; /** * Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged. To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action. */ modifyRule(input: AWS.ELBv2.ModifyRuleInput, options: SdkCallOptions): Promise; /** * Modifies the health checks used when evaluating the health state of the targets in the specified target group. If the protocol of the target group is TCP, TLS, UDP, or TCP_UDP, you can't modify the health check protocol, interval, timeout, or success codes. */ modifyTargetGroup(input: AWS.ELBv2.ModifyTargetGroupInput, options: SdkCallOptions): Promise; /** * Modifies the specified attributes of the specified target group. */ modifyTargetGroupAttributes(input: AWS.ELBv2.ModifyTargetGroupAttributesInput, options: SdkCallOptions): Promise; /** * Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it. By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports. With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address. */ registerTargets(input: AWS.ELBv2.RegisterTargetsInput, options: SdkCallOptions): Promise; /** * Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener. */ removeListenerCertificates(input: AWS.ELBv2.RemoveListenerCertificatesInput, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules. */ removeTags(input: AWS.ELBv2.RemoveTagsInput, options: SdkCallOptions): Promise; /** * Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer. */ setIpAddressType(input: AWS.ELBv2.SetIpAddressTypeInput, options: SdkCallOptions): Promise; /** * Sets the priorities of the specified rules. You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority. */ setRulePriorities(input: AWS.ELBv2.SetRulePrioritiesInput, options: SdkCallOptions): Promise; /** * Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups. You can't specify a security group for a Network Load Balancer or Gateway Load Balancer. */ setSecurityGroups(input: AWS.ELBv2.SetSecurityGroupsInput, options: SdkCallOptions): Promise; /** * Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets. When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets. */ setSubnets(input: AWS.ELBv2.SetSubnetsInput, options: SdkCallOptions): Promise; } export interface EMR { /** * Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x. */ addInstanceFleet(input: AWS.EMR.AddInstanceFleetInput, options: SdkCallOptions): Promise; /** * Adds one or more instance groups to a running cluster. */ addInstanceGroups(input: AWS.EMR.AddInstanceGroupsInput, options: SdkCallOptions): Promise; /** * AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING. The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters. */ addJobFlowSteps(input: AWS.EMR.AddJobFlowStepsInput, options: SdkCallOptions): Promise; /** * Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters. */ addTags(input: AWS.EMR.AddTagsInput, options: SdkCallOptions): Promise; /** * Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR versions 5.28.0 and later, you can cancel steps that are in a PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state. */ cancelSteps(input: AWS.EMR.CancelStepsInput, options: SdkCallOptions): Promise; /** * Creates a security configuration, which is stored in the service and can be specified when a cluster is created. */ createSecurityConfiguration(input: AWS.EMR.CreateSecurityConfigurationInput, options: SdkCallOptions): Promise; /** * Creates a new Amazon EMR Studio. */ createStudio(input: AWS.EMR.CreateStudioInput, options: SdkCallOptions): Promise; /** * Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping to assign users to a Studio when you use Amazon Web Services SSO authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio. */ createStudioSessionMapping(input: AWS.EMR.CreateStudioSessionMappingInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a security configuration. */ deleteSecurityConfiguration(input: AWS.EMR.DeleteSecurityConfigurationInput, options: SdkCallOptions): Promise; /** * Removes an Amazon EMR Studio from the Studio metadata store. */ deleteStudio(input: AWS.EMR.DeleteStudioInput, options: SdkCallOptions): Promise<{}>; /** * Removes a user or group from an Amazon EMR Studio. */ deleteStudioSessionMapping(input: AWS.EMR.DeleteStudioSessionMappingInput, options: SdkCallOptions): Promise<{}>; /** * Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. */ describeCluster(input: AWS.EMR.DescribeClusterInput, options: SdkCallOptions): Promise; /** * This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned: Job flows created and completed in the last two weeks Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon EMR can return a maximum of 512 job flow descriptions. */ describeJobFlows(input: AWS.EMR.DescribeJobFlowsInput, options: SdkCallOptions): Promise; /** * Provides details of a notebook execution. */ describeNotebookExecution(input: AWS.EMR.DescribeNotebookExecutionInput, options: SdkCallOptions): Promise; /** * Provides EMR release label details, such as releases available the region where the API request is run, and the available applications for a specific EMR release label. Can also list EMR release versions that support a specified version of Spark. */ describeReleaseLabel(input: AWS.EMR.DescribeReleaseLabelInput, options: SdkCallOptions): Promise; /** * Provides the details of a security configuration by returning the configuration JSON. */ describeSecurityConfiguration(input: AWS.EMR.DescribeSecurityConfigurationInput, options: SdkCallOptions): Promise; /** * Provides more detail about the cluster step. */ describeStep(input: AWS.EMR.DescribeStepInput, options: SdkCallOptions): Promise; /** * Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on. */ describeStudio(input: AWS.EMR.DescribeStudioInput, options: SdkCallOptions): Promise; /** * Returns the auto-termination policy for an Amazon EMR cluster. */ getAutoTerminationPolicy(input: AWS.EMR.GetAutoTerminationPolicyInput, options: SdkCallOptions): Promise; /** * Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide. */ getBlockPublicAccessConfiguration(input: AWS.EMR.GetBlockPublicAccessConfigurationInput, options: SdkCallOptions): Promise; /** * Fetches the attached managed scaling policy for an Amazon EMR cluster. */ getManagedScalingPolicy(input: AWS.EMR.GetManagedScalingPolicyInput, options: SdkCallOptions): Promise; /** * Fetches mapping details for the specified Amazon EMR Studio and identity (user or group). */ getStudioSessionMapping(input: AWS.EMR.GetStudioSessionMappingInput, options: SdkCallOptions): Promise; /** * Provides information about the bootstrap actions associated with a cluster. */ listBootstrapActions(input: AWS.EMR.ListBootstrapActionsInput, options: SdkCallOptions): Promise; /** * Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. */ listClusters(input: AWS.EMR.ListClustersInput, options: SdkCallOptions): Promise; /** * Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. */ listInstanceFleets(input: AWS.EMR.ListInstanceFleetsInput, options: SdkCallOptions): Promise; /** * Provides all available details about the instance groups in a cluster. */ listInstanceGroups(input: AWS.EMR.ListInstanceGroupsInput, options: SdkCallOptions): Promise; /** * Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING. */ listInstances(input: AWS.EMR.ListInstancesInput, options: SdkCallOptions): Promise; /** * Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecution calls. */ listNotebookExecutions(input: AWS.EMR.ListNotebookExecutionsInput, options: SdkCallOptions): Promise; /** * Retrieves release labels of EMR services in the region where the API is called. */ listReleaseLabels(input: AWS.EMR.ListReleaseLabelsInput, options: SdkCallOptions): Promise; /** * Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls. */ listSecurityConfigurations(input: AWS.EMR.ListSecurityConfigurationsInput, options: SdkCallOptions): Promise; /** * Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request or filter by StepStates. You can specify a maximum of 10 stepIDs. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker, which is a pagination token that indicates the next set of steps to retrieve. */ listSteps(input: AWS.EMR.ListStepsInput, options: SdkCallOptions): Promise; /** * Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId. */ listStudioSessionMappings(input: AWS.EMR.ListStudioSessionMappingsInput, options: SdkCallOptions): Promise; /** * Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio. */ listStudios(input: AWS.EMR.ListStudiosInput, options: SdkCallOptions): Promise; /** * Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID. */ modifyCluster(input: AWS.EMR.ModifyClusterInput, options: SdkCallOptions): Promise; /** * Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. */ modifyInstanceFleet(input: AWS.EMR.ModifyInstanceFleetInput, options: SdkCallOptions): Promise<{}>; /** * ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically. */ modifyInstanceGroups(input: AWS.EMR.ModifyInstanceGroupsInput, options: SdkCallOptions): Promise<{}>; /** * Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. */ putAutoScalingPolicy(input: AWS.EMR.PutAutoScalingPolicyInput, options: SdkCallOptions): Promise; /** * Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy. Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination. */ putAutoTerminationPolicy(input: AWS.EMR.PutAutoTerminationPolicyInput, options: SdkCallOptions): Promise; /** * Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide. */ putBlockPublicAccessConfiguration(input: AWS.EMR.PutBlockPublicAccessConfigurationInput, options: SdkCallOptions): Promise; /** * Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration. */ putManagedScalingPolicy(input: AWS.EMR.PutManagedScalingPolicyInput, options: SdkCallOptions): Promise; /** * Removes an automatic scaling policy from a specified instance group within an EMR cluster. */ removeAutoScalingPolicy(input: AWS.EMR.RemoveAutoScalingPolicyInput, options: SdkCallOptions): Promise; /** * Removes an auto-termination policy from an Amazon EMR cluster. */ removeAutoTerminationPolicy(input: AWS.EMR.RemoveAutoTerminationPolicyInput, options: SdkCallOptions): Promise; /** * Removes a managed scaling policy from a specified EMR cluster. */ removeManagedScalingPolicy(input: AWS.EMR.RemoveManagedScalingPolicyInput, options: SdkCallOptions): Promise; /** * Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters. The following example removes the stack tag with value Prod from a cluster: */ removeTags(input: AWS.EMR.RemoveTagsInput, options: SdkCallOptions): Promise; /** * RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed. For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. For long running clusters, we recommend that you periodically store your results. The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both. */ runJobFlow(input: AWS.EMR.RunJobFlowInput, options: SdkCallOptions): Promise; /** * SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster. SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage. To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false. For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide. */ setTerminationProtection(input: AWS.EMR.SetTerminationProtectionInput, options: SdkCallOptions): Promise<{}>; /** * The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access Management for EMR. Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals. This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide. */ setVisibleToAllUsers(input: AWS.EMR.SetVisibleToAllUsersInput, options: SdkCallOptions): Promise<{}>; /** * Starts a notebook execution. */ startNotebookExecution(input: AWS.EMR.StartNotebookExecutionInput, options: SdkCallOptions): Promise; /** * Stops a notebook execution. */ stopNotebookExecution(input: AWS.EMR.StopNotebookExecutionInput, options: SdkCallOptions): Promise<{}>; /** * TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created. The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances. */ terminateJobFlows(input: AWS.EMR.TerminateJobFlowsInput, options: SdkCallOptions): Promise<{}>; /** * Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets. */ updateStudio(input: AWS.EMR.UpdateStudioInput, options: SdkCallOptions): Promise<{}>; /** * Updates the session policy attached to the user or group for the specified Amazon EMR Studio. */ updateStudioSessionMapping(input: AWS.EMR.UpdateStudioSessionMappingInput, options: SdkCallOptions): Promise<{}>; } export interface EMRcontainers { /** * Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS. */ cancelJobRun(input: AWS.EMRcontainers.CancelJobRunRequest, options: SdkCallOptions): Promise; /** * Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster. */ createManagedEndpoint(input: AWS.EMRcontainers.CreateManagedEndpointRequest, options: SdkCallOptions): Promise; /** * Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. */ createVirtualCluster(input: AWS.EMRcontainers.CreateVirtualClusterRequest, options: SdkCallOptions): Promise; /** * Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster. */ deleteManagedEndpoint(input: AWS.EMRcontainers.DeleteManagedEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. */ deleteVirtualCluster(input: AWS.EMRcontainers.DeleteVirtualClusterRequest, options: SdkCallOptions): Promise; /** * Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS. */ describeJobRun(input: AWS.EMRcontainers.DescribeJobRunRequest, options: SdkCallOptions): Promise; /** * Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster. */ describeManagedEndpoint(input: AWS.EMRcontainers.DescribeManagedEndpointRequest, options: SdkCallOptions): Promise; /** * Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. */ describeVirtualCluster(input: AWS.EMRcontainers.DescribeVirtualClusterRequest, options: SdkCallOptions): Promise; /** * Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS. */ listJobRuns(input: AWS.EMRcontainers.ListJobRunsRequest, options: SdkCallOptions): Promise; /** * Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster. */ listManagedEndpoints(input: AWS.EMRcontainers.ListManagedEndpointsRequest, options: SdkCallOptions): Promise; /** * Lists the tags assigned to the resources. */ listTagsForResource(input: AWS.EMRcontainers.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements. */ listVirtualClusters(input: AWS.EMRcontainers.ListVirtualClustersRequest, options: SdkCallOptions): Promise; /** * Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS. */ startJobRun(input: AWS.EMRcontainers.StartJobRunRequest, options: SdkCallOptions): Promise; /** * Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add. */ tagResource(input: AWS.EMRcontainers.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from resources. */ untagResource(input: AWS.EMRcontainers.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface EMRServerless { /** * Cancels a job run. */ cancelJobRun(input: AWS.EMRServerless.CancelJobRunRequest, options: SdkCallOptions): Promise; /** * Creates an application. */ createApplication(input: AWS.EMRServerless.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes an application. An application has to be in a stopped or created state in order to be deleted. */ deleteApplication(input: AWS.EMRServerless.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * Displays detailed information about a specified application. */ getApplication(input: AWS.EMRServerless.GetApplicationRequest, options: SdkCallOptions): Promise; /** * Returns a URL to access the job run dashboard. */ getDashboardForJobRun(input: AWS.EMRServerless.GetDashboardForJobRunRequest, options: SdkCallOptions): Promise; /** * Displays detailed information about a job run. */ getJobRun(input: AWS.EMRServerless.GetJobRunRequest, options: SdkCallOptions): Promise; /** * Lists applications based on a set of parameters. */ listApplications(input: AWS.EMRServerless.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Lists job runs based on a set of parameters. */ listJobRuns(input: AWS.EMRServerless.ListJobRunsRequest, options: SdkCallOptions): Promise; /** * Lists the tags assigned to the resources. */ listTagsForResource(input: AWS.EMRServerless.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts a specified application and initializes initial capacity if configured. */ startApplication(input: AWS.EMRServerless.StartApplicationRequest, options: SdkCallOptions): Promise; /** * Starts a job run. */ startJobRun(input: AWS.EMRServerless.StartJobRunRequest, options: SdkCallOptions): Promise; /** * Stops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application. */ stopApplication(input: AWS.EMRServerless.StopApplicationRequest, options: SdkCallOptions): Promise; /** * Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it. */ tagResource(input: AWS.EMRServerless.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from resources. */ untagResource(input: AWS.EMRServerless.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a specified application. An application has to be in a stopped or created state in order to be updated. */ updateApplication(input: AWS.EMRServerless.UpdateApplicationRequest, options: SdkCallOptions): Promise; } export interface ES { /** * Allows the destination domain owner to accept an inbound cross-cluster search connection request. */ acceptInboundCrossClusterSearchConnection(input: AWS.ES.AcceptInboundCrossClusterSearchConnectionRequest, options: SdkCallOptions): Promise; /** * Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information. */ addTags(input: AWS.ES.AddTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Associates a package with an Amazon ES domain. */ associatePackage(input: AWS.ES.AssociatePackageRequest, options: SdkCallOptions): Promise; /** * Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state. */ cancelElasticsearchServiceSoftwareUpdate(input: AWS.ES.CancelElasticsearchServiceSoftwareUpdateRequest, options: SdkCallOptions): Promise; /** * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide. */ createElasticsearchDomain(input: AWS.ES.CreateElasticsearchDomainRequest, options: SdkCallOptions): Promise; /** * Creates a new cross-cluster search connection from a source domain to a destination domain. */ createOutboundCrossClusterSearchConnection(input: AWS.ES.CreateOutboundCrossClusterSearchConnectionRequest, options: SdkCallOptions): Promise; /** * Create a package for use with Amazon ES domains. */ createPackage(input: AWS.ES.CreatePackageRequest, options: SdkCallOptions): Promise; /** * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. */ deleteElasticsearchDomain(input: AWS.ES.DeleteElasticsearchDomainRequest, options: SdkCallOptions): Promise; /** * Allows the destination domain owner to delete an existing inbound cross-cluster search connection. */ deleteInboundCrossClusterSearchConnection(input: AWS.ES.DeleteInboundCrossClusterSearchConnectionRequest, options: SdkCallOptions): Promise; /** * Allows the source domain owner to delete an existing outbound cross-cluster search connection. */ deleteOutboundCrossClusterSearchConnection(input: AWS.ES.DeleteOutboundCrossClusterSearchConnectionRequest, options: SdkCallOptions): Promise; /** * Delete the package. */ deletePackage(input: AWS.ES.DeletePackageRequest, options: SdkCallOptions): Promise; /** * Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date. */ describeDomainAutoTunes(input: AWS.ES.DescribeDomainAutoTunesRequest, options: SdkCallOptions): Promise; /** * Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages. */ describeDomainChangeProgress(input: AWS.ES.DescribeDomainChangeProgressRequest, options: SdkCallOptions): Promise; /** * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN. */ describeElasticsearchDomain(input: AWS.ES.DescribeElasticsearchDomainRequest, options: SdkCallOptions): Promise; /** * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options. */ describeElasticsearchDomainConfig(input: AWS.ES.DescribeElasticsearchDomainConfigRequest, options: SdkCallOptions): Promise; /** * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN. */ describeElasticsearchDomains(input: AWS.ES.DescribeElasticsearchDomainsRequest, options: SdkCallOptions): Promise; /** * Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying. */ describeElasticsearchInstanceTypeLimits(input: AWS.ES.DescribeElasticsearchInstanceTypeLimitsRequest, options: SdkCallOptions): Promise; /** * Lists all the inbound cross-cluster search connections for a destination domain. */ describeInboundCrossClusterSearchConnections(input: AWS.ES.DescribeInboundCrossClusterSearchConnectionsRequest, options: SdkCallOptions): Promise; /** * Lists all the outbound cross-cluster search connections for a source domain. */ describeOutboundCrossClusterSearchConnections(input: AWS.ES.DescribeOutboundCrossClusterSearchConnectionsRequest, options: SdkCallOptions): Promise; /** * Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination. */ describePackages(input: AWS.ES.DescribePackagesRequest, options: SdkCallOptions): Promise; /** * Lists available reserved Elasticsearch instance offerings. */ describeReservedElasticsearchInstanceOfferings(input: AWS.ES.DescribeReservedElasticsearchInstanceOfferingsRequest, options: SdkCallOptions): Promise; /** * Returns information about reserved Elasticsearch instances for this account. */ describeReservedElasticsearchInstances(input: AWS.ES.DescribeReservedElasticsearchInstancesRequest, options: SdkCallOptions): Promise; /** * Dissociates a package from the Amazon ES domain. */ dissociatePackage(input: AWS.ES.DissociatePackageRequest, options: SdkCallOptions): Promise; /** * Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain. */ getCompatibleElasticsearchVersions(input: AWS.ES.GetCompatibleElasticsearchVersionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of versions of the package, along with their creation time and commit message. */ getPackageVersionHistory(input: AWS.ES.GetPackageVersionHistoryRequest, options: SdkCallOptions): Promise; /** * Retrieves the complete history of the last 10 upgrades that were performed on the domain. */ getUpgradeHistory(input: AWS.ES.GetUpgradeHistoryRequest, options: SdkCallOptions): Promise; /** * Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain. */ getUpgradeStatus(input: AWS.ES.GetUpgradeStatusRequest, options: SdkCallOptions): Promise; /** * Returns the name of all Elasticsearch domains owned by the current user's account. */ listDomainNames(input: AWS.ES.ListDomainNamesRequest, options: SdkCallOptions): Promise; /** * Lists all Amazon ES domains associated with the package. */ listDomainsForPackage(input: AWS.ES.ListDomainsForPackageRequest, options: SdkCallOptions): Promise; /** * List all Elasticsearch instance types that are supported for given ElasticsearchVersion */ listElasticsearchInstanceTypes(input: AWS.ES.ListElasticsearchInstanceTypesRequest, options: SdkCallOptions): Promise; /** * List all supported Elasticsearch versions */ listElasticsearchVersions(input: AWS.ES.ListElasticsearchVersionsRequest, options: SdkCallOptions): Promise; /** * Lists all packages associated with the Amazon ES domain. */ listPackagesForDomain(input: AWS.ES.ListPackagesForDomainRequest, options: SdkCallOptions): Promise; /** * Returns all tags for the given Elasticsearch domain. */ listTags(input: AWS.ES.ListTagsRequest, options: SdkCallOptions): Promise; /** * Allows you to purchase reserved Elasticsearch instances. */ purchaseReservedElasticsearchInstanceOffering(input: AWS.ES.PurchaseReservedElasticsearchInstanceOfferingRequest, options: SdkCallOptions): Promise; /** * Allows the destination domain owner to reject an inbound cross-cluster search connection request. */ rejectInboundCrossClusterSearchConnection(input: AWS.ES.RejectInboundCrossClusterSearchConnectionRequest, options: SdkCallOptions): Promise; /** * Removes the specified set of tags from the specified Elasticsearch domain. */ removeTags(input: AWS.ES.RemoveTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Schedules a service software update for an Amazon ES domain. */ startElasticsearchServiceSoftwareUpdate(input: AWS.ES.StartElasticsearchServiceSoftwareUpdateRequest, options: SdkCallOptions): Promise; /** * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. */ updateElasticsearchDomainConfig(input: AWS.ES.UpdateElasticsearchDomainConfigRequest, options: SdkCallOptions): Promise; /** * Updates a package for use with Amazon ES domains. */ updatePackage(input: AWS.ES.UpdatePackageRequest, options: SdkCallOptions): Promise; /** * Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version. */ upgradeElasticsearchDomain(input: AWS.ES.UpgradeElasticsearchDomainRequest, options: SdkCallOptions): Promise; } export interface EventBridge { /** * Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source. */ activateEventSource(input: AWS.EventBridge.ActivateEventSourceRequest, options: SdkCallOptions): Promise<{}>; /** * Cancels the specified replay. */ cancelReplay(input: AWS.EventBridge.CancelReplayRequest, options: SdkCallOptions): Promise; /** * Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. */ createApiDestination(input: AWS.EventBridge.CreateApiDestinationRequest, options: SdkCallOptions): Promise; /** * Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive. */ createArchive(input: AWS.EventBridge.CreateArchiveRequest, options: SdkCallOptions): Promise; /** * Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. */ createConnection(input: AWS.EventBridge.CreateConnectionRequest, options: SdkCallOptions): Promise; /** * Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state. */ createEndpoint(input: AWS.EventBridge.CreateEndpointRequest, options: SdkCallOptions): Promise; /** * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source. */ createEventBus(input: AWS.EventBridge.CreateEventBusRequest, options: SdkCallOptions): Promise; /** * Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types. A partner event source creates events based on resources within the SaaS partner's service or application. An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets. Partner event source names follow this format: partner_name/event_namespace/event_name partner_name is determined during partner registration and identifies the partner to Amazon Web Services customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events. */ createPartnerEventSource(input: AWS.EventBridge.CreatePartnerEventSourceRequest, options: SdkCallOptions): Promise; /** * You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted. To activate a deactivated partner event source, use ActivateEventSource. */ deactivateEventSource(input: AWS.EventBridge.DeactivateEventSourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection. */ deauthorizeConnection(input: AWS.EventBridge.DeauthorizeConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified API destination. */ deleteApiDestination(input: AWS.EventBridge.DeleteApiDestinationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified archive. */ deleteArchive(input: AWS.EventBridge.DeleteArchiveRequest, options: SdkCallOptions): Promise; /** * Deletes a connection. */ deleteConnection(input: AWS.EventBridge.DeleteConnectionRequest, options: SdkCallOptions): Promise; /** * Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide. */ deleteEndpoint(input: AWS.EventBridge.DeleteEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus. */ deleteEventBus(input: AWS.EventBridge.DeleteEventBusRequest, options: SdkCallOptions): Promise<{}>; /** * This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED. */ deletePartnerEventSource(input: AWS.EventBridge.DeletePartnerEventSourceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule. */ deleteRule(input: AWS.EventBridge.DeleteRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves details about an API destination. */ describeApiDestination(input: AWS.EventBridge.DescribeApiDestinationRequest, options: SdkCallOptions): Promise; /** * Retrieves details about an archive. */ describeArchive(input: AWS.EventBridge.DescribeArchiveRequest, options: SdkCallOptions): Promise; /** * Retrieves details about a connection. */ describeConnection(input: AWS.EventBridge.DescribeConnectionRequest, options: SdkCallOptions): Promise; /** * Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.. */ describeEndpoint(input: AWS.EventBridge.DescribeEndpointRequest, options: SdkCallOptions): Promise; /** * Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time. To enable your account to receive events from other accounts on its default event bus, use PutPermission. For more information about partner event buses, see CreateEventBus. */ describeEventBus(input: AWS.EventBridge.DescribeEventBusRequest, options: SdkCallOptions): Promise; /** * This operation lists details about a partner event source that is shared with your account. */ describeEventSource(input: AWS.EventBridge.DescribeEventSourceRequest, options: SdkCallOptions): Promise; /** * An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them. */ describePartnerEventSource(input: AWS.EventBridge.DescribePartnerEventSourceRequest, options: SdkCallOptions): Promise; /** * Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed. */ describeReplay(input: AWS.EventBridge.DescribeReplayRequest, options: SdkCallOptions): Promise; /** * Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. */ describeRule(input: AWS.EventBridge.DescribeRuleRequest, options: SdkCallOptions): Promise; /** * Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect. */ disableRule(input: AWS.EventBridge.DisableRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Enables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect. */ enableRule(input: AWS.EventBridge.EnableRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves a list of API destination in the account in the current Region. */ listApiDestinations(input: AWS.EventBridge.ListApiDestinationsRequest, options: SdkCallOptions): Promise; /** * Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive. */ listArchives(input: AWS.EventBridge.ListArchivesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of connections from the account. */ listConnections(input: AWS.EventBridge.ListConnectionsRequest, options: SdkCallOptions): Promise; /** * List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.. */ listEndpoints(input: AWS.EventBridge.ListEndpointsRequest, options: SdkCallOptions): Promise; /** * Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses. */ listEventBuses(input: AWS.EventBridge.ListEventBusesRequest, options: SdkCallOptions): Promise; /** * You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus. */ listEventSources(input: AWS.EventBridge.ListEventSourcesRequest, options: SdkCallOptions): Promise; /** * An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers. */ listPartnerEventSourceAccounts(input: AWS.EventBridge.ListPartnerEventSourceAccountsRequest, options: SdkCallOptions): Promise; /** * An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers. */ listPartnerEventSources(input: AWS.EventBridge.ListPartnerEventSourcesRequest, options: SdkCallOptions): Promise; /** * Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive. */ listReplays(input: AWS.EventBridge.ListReplaysRequest, options: SdkCallOptions): Promise; /** * Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account. */ listRuleNamesByTarget(input: AWS.EventBridge.ListRuleNamesByTargetRequest, options: SdkCallOptions): Promise; /** * Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. */ listRules(input: AWS.EventBridge.ListRulesRequest, options: SdkCallOptions): Promise; /** * Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged. */ listTagsForResource(input: AWS.EventBridge.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the targets assigned to the specified rule. */ listTargetsByRule(input: AWS.EventBridge.ListTargetsByRuleRequest, options: SdkCallOptions): Promise; /** * Sends custom events to Amazon EventBridge so that they can be matched to rules. PutEvents will only process nested JSON up to 1100 levels deep. */ putEvents(input: AWS.EventBridge.PutEventsRequest, options: SdkCallOptions): Promise; /** * This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation. */ putPartnerEvents(input: AWS.EventBridge.PutPartnerEventsRequest, options: SdkCallOptions): Promise; /** * Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account. For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target. To enable multiple Amazon Web Services accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide. The permission policy on the event bus cannot exceed 10 KB in size. */ putPermission(input: AWS.EventBridge.PutPermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule. A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus. If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets. */ putRule(input: AWS.EventBridge.PutRuleRequest, options: SdkCallOptions): Promise; /** * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. Each rule can have up to five (5) targets associated with it at one time. You can configure the following as targets for Events: API destination API Gateway Batch job queue CloudWatch group CodeBuild project CodePipeline EC2 CreateSnapshot API call EC2 Image Builder EC2 RebootInstances API call EC2 StopInstances API call EC2 TerminateInstances API call ECS task Event bus in a different account or Region Event bus in the same account and Region Firehose delivery stream Glue workflow Incident Manager response plan Inspector assessment template Kinesis stream Lambda function Redshift cluster SageMaker Pipeline SNS topic SQS queue Step Functions state machine Systems Manager Automation Systems Manager OpsItem Systems Manager Run Command Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide. If another Amazon Web Services account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services account. If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. */ putTargets(input: AWS.EventBridge.PutTargetsRequest, options: SdkCallOptions): Promise; /** * Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus. */ removePermission(input: AWS.EventBridge.RemovePermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed. When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. */ removeTargets(input: AWS.EventBridge.RemoveTargetsRequest, options: SdkCallOptions): Promise; /** * Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed. */ startReplay(input: AWS.EventBridge.StartReplayRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. */ tagResource(input: AWS.EventBridge.TagResourceRequest, options: SdkCallOptions): Promise; /** * Tests whether the specified event pattern matches the provided event. Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. */ testEventPattern(input: AWS.EventBridge.TestEventPatternRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged. */ untagResource(input: AWS.EventBridge.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an API destination. */ updateApiDestination(input: AWS.EventBridge.UpdateApiDestinationRequest, options: SdkCallOptions): Promise; /** * Updates the specified archive. */ updateArchive(input: AWS.EventBridge.UpdateArchiveRequest, options: SdkCallOptions): Promise; /** * Updates settings for a connection. */ updateConnection(input: AWS.EventBridge.UpdateConnectionRequest, options: SdkCallOptions): Promise; /** * Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.. */ updateEndpoint(input: AWS.EventBridge.UpdateEndpointRequest, options: SdkCallOptions): Promise; } export interface Evidently { /** * This operation assigns feature variation to user sessions. For each user session, you pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule. Next, if there is a launch of the feature, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch. If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. If the user is not assigned to a launch or experiment, they are served the default variation. */ batchEvaluateFeature(input: AWS.Evidently.BatchEvaluateFeatureRequest, options: SdkCallOptions): Promise; /** * Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment. An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better. You can optionally specify a segment to have the experiment consider only certain audience types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser. Don't use this operation to update an existing experiment. Instead, use UpdateExperiment. */ createExperiment(input: AWS.Evidently.CreateExperimentRequest, options: SdkCallOptions): Promise; /** * Creates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see CreateProject. Don't use this operation to update an existing feature. Instead, use UpdateFeature. */ createFeature(input: AWS.Evidently.CreateFeatureRequest, options: SdkCallOptions): Promise; /** * Creates a launch of a given feature. Before you create a launch, you must create the feature to use for the launch. You can use a launch to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature. Don't use this operation to update an existing launch. Instead, use UpdateLaunch. */ createLaunch(input: AWS.Evidently.CreateLaunchRequest, options: SdkCallOptions): Promise; /** * Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together. To update an existing project, use UpdateProject. */ createProject(input: AWS.Evidently.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Use this operation to define a segment of your audience. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age. Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allows you to define different traffic splits for the different audience segments. <p>For more information about segment pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html"> Segment rule pattern syntax</a>.</p> <p>The pattern that you define for a segment is matched against the value of <code>evaluationContext</code>, which is passed into Evidently in the <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html">EvaluateFeature</a> operation, when Evidently assigns a feature variation to a user.</p> */ createSegment(input: AWS.Evidently.CreateSegmentRequest, options: SdkCallOptions): Promise; /** * Deletes an Evidently experiment. The feature used for the experiment is not deleted. To stop an experiment without deleting it, use StopExperiment. */ deleteExperiment(input: AWS.Evidently.DeleteExperimentRequest, options: SdkCallOptions): Promise; /** * Deletes an Evidently feature. */ deleteFeature(input: AWS.Evidently.DeleteFeatureRequest, options: SdkCallOptions): Promise; /** * Deletes an Evidently launch. The feature used for the launch is not deleted. To stop a launch without deleting it, use StopLaunch. */ deleteLaunch(input: AWS.Evidently.DeleteLaunchRequest, options: SdkCallOptions): Promise; /** * Deletes an Evidently project. Before you can delete a project, you must delete all the features that the project contains. To delete a feature, use DeleteFeature. */ deleteProject(input: AWS.Evidently.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Deletes a segment. You can't delete a segment that is being used in a launch or experiment, even if that launch or experiment is not currently running. */ deleteSegment(input: AWS.Evidently.DeleteSegmentRequest, options: SdkCallOptions): Promise; /** * This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule. <p>If there is a current launch with this feature that uses segment overrides, and if the user session's <code>evaluationContext</code> matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html">CreateSegment</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html">Use segments to focus your audience</a>.</p> <p>If there is a launch with no segment overrides, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.</p> <p>If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment.</p> <p>If the experiment uses a segment, then only user sessions with <code>evaluationContext</code> values that match the segment rule are used in the experiment.</p> <p>If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. </p> <p>If the user is not assigned to a launch or experiment, they are served the default variation.</p> */ evaluateFeature(input: AWS.Evidently.EvaluateFeatureRequest, options: SdkCallOptions): Promise; /** * Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments. */ getExperiment(input: AWS.Evidently.GetExperimentRequest, options: SdkCallOptions): Promise; /** * Retrieves the results of a running or completed experiment. No results are available until there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during the experiment do not find statistical significance. Experiment results are available up to 63 days after the start of the experiment. They are not available after that because of CloudWatch data retention policies. */ getExperimentResults(input: AWS.Evidently.GetExperimentResultsRequest, options: SdkCallOptions): Promise; /** * Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use ListFeatures. */ getFeature(input: AWS.Evidently.GetFeatureRequest, options: SdkCallOptions): Promise; /** * Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches. */ getLaunch(input: AWS.Evidently.GetLaunchRequest, options: SdkCallOptions): Promise; /** * Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects. */ getProject(input: AWS.Evidently.GetProjectRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified segment. Specify the segment you want to view by specifying its ARN. */ getSegment(input: AWS.Evidently.GetSegmentRequest, options: SdkCallOptions): Promise; /** * Returns configuration details about all the experiments in the specified project. */ listExperiments(input: AWS.Evidently.ListExperimentsRequest, options: SdkCallOptions): Promise; /** * Returns configuration details about all the features in the specified project. */ listFeatures(input: AWS.Evidently.ListFeaturesRequest, options: SdkCallOptions): Promise; /** * Returns configuration details about all the launches in the specified project. */ listLaunches(input: AWS.Evidently.ListLaunchesRequest, options: SdkCallOptions): Promise; /** * Returns configuration details about all the projects in the current Region in your account. */ listProjects(input: AWS.Evidently.ListProjectsRequest, options: SdkCallOptions): Promise; /** * Use this operation to find which experiments or launches are using a specified segment. */ listSegmentReferences(input: AWS.Evidently.ListSegmentReferencesRequest, options: SdkCallOptions): Promise; /** * Returns a list of audience segments that you have created in your account in this Region. */ listSegments(input: AWS.Evidently.ListSegmentsRequest, options: SdkCallOptions): Promise; /** * Displays the tags associated with an Evidently resource. */ listTagsForResource(input: AWS.Evidently.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment. */ putProjectEvents(input: AWS.Evidently.PutProjectEventsRequest, options: SdkCallOptions): Promise; /** * Starts an existing experiment. To create an experiment, use CreateExperiment. */ startExperiment(input: AWS.Evidently.StartExperimentRequest, options: SdkCallOptions): Promise; /** * Starts an existing launch. To create a launch, use CreateLaunch. */ startLaunch(input: AWS.Evidently.StartLaunchRequest, options: SdkCallOptions): Promise; /** * Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it. */ stopExperiment(input: AWS.Evidently.StopExperimentRequest, options: SdkCallOptions): Promise; /** * Stops a launch that is currently running. After you stop a launch, you will not be able to resume it or restart it. Also, it will not be evaluated as a rule for traffic allocation, and the traffic that was allocated to the launch will instead be available to the feature's experiment, if there is one. Otherwise, all traffic will be served the default variation after the launch is stopped. */ stopLaunch(input: AWS.Evidently.StopLaunchRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource. Projects, features, launches, and experiments can be tagged. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. For more information, see Tagging Amazon Web Services resources. */ tagResource(input: AWS.Evidently.TagResourceRequest, options: SdkCallOptions): Promise; /** * Use this operation to test a rules pattern that you plan to use to create an audience segment. For more information about segments, see CreateSegment. */ testSegmentPattern(input: AWS.Evidently.TestSegmentPatternRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. */ untagResource(input: AWS.Evidently.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an Evidently experiment. Don't use this operation to update an experiment's tag. Instead, use TagResource. */ updateExperiment(input: AWS.Evidently.UpdateExperimentRequest, options: SdkCallOptions): Promise; /** * Updates an existing feature. You can't use this operation to update the tags of an existing feature. Instead, use TagResource. */ updateFeature(input: AWS.Evidently.UpdateFeatureRequest, options: SdkCallOptions): Promise; /** * Updates a launch of a given feature. Don't use this operation to update the tags of an existing launch. Instead, use TagResource. */ updateLaunch(input: AWS.Evidently.UpdateLaunchRequest, options: SdkCallOptions): Promise; /** * Updates the description of an existing project. To create a new project, use CreateProject. Don't use this operation to update the data storage options of a project. Instead, use UpdateProjectDataDelivery. Don't use this operation to update the tags of a project. Instead, use TagResource. */ updateProject(input: AWS.Evidently.UpdateProjectRequest, options: SdkCallOptions): Promise; /** * Updates the data storage options for this project. If you store evaluation events, you an keep them and analyze them on your own. If you choose not to store evaluation events, Evidently deletes them after using them to produce metrics and other experiment results that you can view. You can't specify both cloudWatchLogs and s3Destination in the same operation. */ updateProjectDataDelivery(input: AWS.Evidently.UpdateProjectDataDeliveryRequest, options: SdkCallOptions): Promise; } export interface Finspace { /** * Create a new FinSpace environment. */ createEnvironment(input: AWS.Finspace.CreateEnvironmentRequest, options: SdkCallOptions): Promise; /** * Delete an FinSpace environment. */ deleteEnvironment(input: AWS.Finspace.DeleteEnvironmentRequest, options: SdkCallOptions): Promise; /** * Returns the FinSpace environment object. */ getEnvironment(input: AWS.Finspace.GetEnvironmentRequest, options: SdkCallOptions): Promise; /** * A list of all of your FinSpace environments. */ listEnvironments(input: AWS.Finspace.ListEnvironmentsRequest, options: SdkCallOptions): Promise; /** * A list of all tags for a resource. */ listTagsForResource(input: AWS.Finspace.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds metadata tags to a FinSpace resource. */ tagResource(input: AWS.Finspace.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes metadata tags from a FinSpace resource. */ untagResource(input: AWS.Finspace.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update your FinSpace environment. */ updateEnvironment(input: AWS.Finspace.UpdateEnvironmentRequest, options: SdkCallOptions): Promise; } export interface Finspacedata { /** * Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace. */ associateUserToPermissionGroup(input: AWS.Finspacedata.AssociateUserToPermissionGroupRequest, options: SdkCallOptions): Promise; /** * Creates a new Changeset in a FinSpace Dataset. */ createChangeset(input: AWS.Finspacedata.CreateChangesetRequest, options: SdkCallOptions): Promise; /** * Creates a Dataview for a Dataset. */ createDataView(input: AWS.Finspacedata.CreateDataViewRequest, options: SdkCallOptions): Promise; /** * Creates a new FinSpace Dataset. */ createDataset(input: AWS.Finspacedata.CreateDatasetRequest, options: SdkCallOptions): Promise; /** * Creates a group of permissions for various actions that a user can perform in FinSpace. */ createPermissionGroup(input: AWS.Finspacedata.CreatePermissionGroupRequest, options: SdkCallOptions): Promise; /** * Creates a new user in FinSpace. */ createUser(input: AWS.Finspacedata.CreateUserRequest, options: SdkCallOptions): Promise; /** * Deletes a FinSpace Dataset. */ deleteDataset(input: AWS.Finspacedata.DeleteDatasetRequest, options: SdkCallOptions): Promise; /** * Deletes a permission group. This action is irreversible. */ deletePermissionGroup(input: AWS.Finspacedata.DeletePermissionGroupRequest, options: SdkCallOptions): Promise; /** * Denies access to the FinSpace web application and API for the specified user. */ disableUser(input: AWS.Finspacedata.DisableUserRequest, options: SdkCallOptions): Promise; /** * Removes a user account from a permission group. */ disassociateUserFromPermissionGroup(input: AWS.Finspacedata.DisassociateUserFromPermissionGroupRequest, options: SdkCallOptions): Promise; /** * Allows the specified user to access the FinSpace web application and API. */ enableUser(input: AWS.Finspacedata.EnableUserRequest, options: SdkCallOptions): Promise; /** * Get information about a Changeset. */ getChangeset(input: AWS.Finspacedata.GetChangesetRequest, options: SdkCallOptions): Promise; /** * Gets information about a Dataview. */ getDataView(input: AWS.Finspacedata.GetDataViewRequest, options: SdkCallOptions): Promise; /** * Returns information about a Dataset. */ getDataset(input: AWS.Finspacedata.GetDatasetRequest, options: SdkCallOptions): Promise; /** * Returns the credentials to access the external Dataview from an S3 location. To call this API: You must retrieve the programmatic credentials. You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions. */ getExternalDataViewAccessDetails(input: AWS.Finspacedata.GetExternalDataViewAccessDetailsRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a specific permission group. */ getPermissionGroup(input: AWS.Finspacedata.GetPermissionGroupRequest, options: SdkCallOptions): Promise; /** * Request programmatic credentials to use with FinSpace SDK. */ getProgrammaticAccessCredentials(input: AWS.Finspacedata.GetProgrammaticAccessCredentialsRequest, options: SdkCallOptions): Promise; /** * Retrieves details for a specific user. */ getUser(input: AWS.Finspacedata.GetUserRequest, options: SdkCallOptions): Promise; /** * A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook. */ getWorkingLocation(input: AWS.Finspacedata.GetWorkingLocationRequest, options: SdkCallOptions): Promise; /** * Lists the FinSpace Changesets for a Dataset. */ listChangesets(input: AWS.Finspacedata.ListChangesetsRequest, options: SdkCallOptions): Promise; /** * Lists all available Dataviews for a Dataset. */ listDataViews(input: AWS.Finspacedata.ListDataViewsRequest, options: SdkCallOptions): Promise; /** * Lists all of the active Datasets that a user has access to. */ listDatasets(input: AWS.Finspacedata.ListDatasetsRequest, options: SdkCallOptions): Promise; /** * Lists all available permission groups in FinSpace. */ listPermissionGroups(input: AWS.Finspacedata.ListPermissionGroupsRequest, options: SdkCallOptions): Promise; /** * Lists all the permission groups that are associated with a specific user account. */ listPermissionGroupsByUser(input: AWS.Finspacedata.ListPermissionGroupsByUserRequest, options: SdkCallOptions): Promise; /** * Lists all available user accounts in FinSpace. */ listUsers(input: AWS.Finspacedata.ListUsersRequest, options: SdkCallOptions): Promise; /** * Lists details of all the users in a specific permission group. */ listUsersByPermissionGroup(input: AWS.Finspacedata.ListUsersByPermissionGroupRequest, options: SdkCallOptions): Promise; /** * Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user. */ resetUserPassword(input: AWS.Finspacedata.ResetUserPasswordRequest, options: SdkCallOptions): Promise; /** * Updates a FinSpace Changeset. */ updateChangeset(input: AWS.Finspacedata.UpdateChangesetRequest, options: SdkCallOptions): Promise; /** * Updates a FinSpace Dataset. */ updateDataset(input: AWS.Finspacedata.UpdateDatasetRequest, options: SdkCallOptions): Promise; /** * Modifies the details of a permission group. You cannot modify a permissionGroupID. */ updatePermissionGroup(input: AWS.Finspacedata.UpdatePermissionGroupRequest, options: SdkCallOptions): Promise; /** * Modifies the details of the specified user account. You cannot update the userId for a user. */ updateUser(input: AWS.Finspacedata.UpdateUserRequest, options: SdkCallOptions): Promise; } export interface Firehose { /** * Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per AWS Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide. */ createDeliveryStream(input: AWS.Firehose.CreateDeliveryStreamInput, options: SdkCallOptions): Promise; /** * Deletes a delivery stream and its data. To check the state of a delivery stream, use DescribeDeliveryStream. You can delete a delivery stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a delivery stream that is in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. While the delivery stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a delivery stream. */ deleteDeliveryStream(input: AWS.Firehose.DeleteDeliveryStreamInput, options: SdkCallOptions): Promise; /** * Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true. */ describeDeliveryStream(input: AWS.Firehose.DescribeDeliveryStreamInput, options: SdkCallOptions): Promise; /** * Lists your delivery streams in alphabetical order of their names. The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call. */ listDeliveryStreams(input: AWS.Firehose.ListDeliveryStreamsInput, options: SdkCallOptions): Promise; /** * Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account. */ listTagsForDeliveryStream(input: AWS.Firehose.ListTagsForDeliveryStreamInput, options: SdkCallOptions): Promise; /** * Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KiB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding. */ putRecord(input: AWS.Firehose.PutRecordInput, options: SdkCallOptions): Promise; /** * Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers. For information about service quota, see Amazon Kinesis Data Firehose Quota. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination. If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding. */ putRecordBatch(input: AWS.Firehose.PutRecordBatchInput, options: SdkCallOptions): Promise; /** * Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption status of a delivery stream, use DescribeDeliveryStream. Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant. If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK. If the encryption status of your delivery stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Kinesis Data Firehose to invoke KMS encrypt and decrypt operations. You can enable SSE for a delivery stream only if it's a delivery stream that uses DirectPut as its source. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period. */ startDeliveryStreamEncryption(input: AWS.Firehose.StartDeliveryStreamEncryptionInput, options: SdkCallOptions): Promise; /** * Disables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a delivery stream, use DescribeDeliveryStream. If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Kinesis Data Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period. */ stopDeliveryStreamEncryption(input: AWS.Firehose.StopDeliveryStreamEncryptionInput, options: SdkCallOptions): Promise; /** * Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. Each delivery stream can have up to 50 tags. This operation has a limit of five transactions per second per account. */ tagDeliveryStream(input: AWS.Firehose.TagDeliveryStreamInput, options: SdkCallOptions): Promise; /** * Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes. If you specify a tag that doesn't exist, the operation ignores it. This operation has a limit of five transactions per second per account. */ untagDeliveryStream(input: AWS.Firehose.UntagDeliveryStreamInput, options: SdkCallOptions): Promise; /** * Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination. If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call. */ updateDestination(input: AWS.Firehose.UpdateDestinationInput, options: SdkCallOptions): Promise; } export interface Fis { /** * Creates an experiment template. An experiment template includes the following components: Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags. Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment. Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm. For more information, see Experiment templates in the Fault Injection Simulator User Guide. */ createExperimentTemplate(input: AWS.Fis.CreateExperimentTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes the specified experiment template. */ deleteExperimentTemplate(input: AWS.Fis.DeleteExperimentTemplateRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified FIS action. */ getAction(input: AWS.Fis.GetActionRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified experiment. */ getExperiment(input: AWS.Fis.GetExperimentRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified experiment template. */ getExperimentTemplate(input: AWS.Fis.GetExperimentTemplateRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified resource type. */ getTargetResourceType(input: AWS.Fis.GetTargetResourceTypeRequest, options: SdkCallOptions): Promise; /** * Lists the available FIS actions. */ listActions(input: AWS.Fis.ListActionsRequest, options: SdkCallOptions): Promise; /** * Lists your experiment templates. */ listExperimentTemplates(input: AWS.Fis.ListExperimentTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists your experiments. */ listExperiments(input: AWS.Fis.ListExperimentsRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.Fis.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the target resource types. */ listTargetResourceTypes(input: AWS.Fis.ListTargetResourceTypesRequest, options: SdkCallOptions): Promise; /** * Starts running an experiment from the specified experiment template. */ startExperiment(input: AWS.Fis.StartExperimentRequest, options: SdkCallOptions): Promise; /** * Stops the specified experiment. */ stopExperiment(input: AWS.Fis.StopExperimentRequest, options: SdkCallOptions): Promise; /** * Applies the specified tags to the specified resource. */ tagResource(input: AWS.Fis.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified resource. */ untagResource(input: AWS.Fis.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified experiment template. */ updateExperimentTemplate(input: AWS.Fis.UpdateExperimentTemplateRequest, options: SdkCallOptions): Promise; } export interface FMS { /** * Sets the Firewall Manager administrator account. The account must be a member of the organization in Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies. The account that you associate with Firewall Manager is called the Firewall Manager administrator account. */ associateAdminAccount(input: AWS.FMS.AssociateAdminAccountRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account. */ associateThirdPartyFirewall(input: AWS.FMS.AssociateThirdPartyFirewallRequest, options: SdkCallOptions): Promise; /** * Permanently deletes an Firewall Manager applications list. */ deleteAppsList(input: AWS.FMS.DeleteAppsListRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs. */ deleteNotificationChannel(input: AWS.FMS.DeleteNotificationChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Permanently deletes an Firewall Manager policy. */ deletePolicy(input: AWS.FMS.DeletePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Permanently deletes an Firewall Manager protocols list. */ deleteProtocolsList(input: AWS.FMS.DeleteProtocolsListRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates the account that has been set as the Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request. */ disassociateAdminAccount(input: AWS.FMS.DisassociateAdminAccountRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account. */ disassociateThirdPartyFirewall(input: AWS.FMS.DisassociateThirdPartyFirewallRequest, options: SdkCallOptions): Promise; /** * Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator. */ getAdminAccount(input: AWS.FMS.GetAdminAccountRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified Firewall Manager applications list. */ getAppsList(input: AWS.FMS.GetAppsListRequest, options: SdkCallOptions): Promise; /** * Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible. Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules. Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC. */ getComplianceDetail(input: AWS.FMS.GetComplianceDetailRequest, options: SdkCallOptions): Promise; /** * Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs. */ getNotificationChannel(input: AWS.FMS.GetNotificationChannelRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified Firewall Manager policy. */ getPolicy(input: AWS.FMS.GetPolicyRequest, options: SdkCallOptions): Promise; /** * If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported. */ getProtectionStatus(input: AWS.FMS.GetProtectionStatusRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified Firewall Manager protocols list. */ getProtocolsList(input: AWS.FMS.GetProtocolsListRequest, options: SdkCallOptions): Promise; /** * The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant. */ getThirdPartyFirewallAssociationStatus(input: AWS.FMS.GetThirdPartyFirewallAssociationStatusRequest, options: SdkCallOptions): Promise; /** * Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account. */ getViolationDetails(input: AWS.FMS.GetViolationDetailsRequest, options: SdkCallOptions): Promise; /** * Returns an array of AppsListDataSummary objects. */ listAppsLists(input: AWS.FMS.ListAppsListsRequest, options: SdkCallOptions): Promise; /** * Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy. */ listComplianceStatus(input: AWS.FMS.ListComplianceStatusRequest, options: SdkCallOptions): Promise; /** * Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization. The ListMemberAccounts must be submitted by the account that is set as the Firewall Manager administrator. */ listMemberAccounts(input: AWS.FMS.ListMemberAccountsRequest, options: SdkCallOptions): Promise; /** * Returns an array of PolicySummary objects. */ listPolicies(input: AWS.FMS.ListPoliciesRequest, options: SdkCallOptions): Promise; /** * Returns an array of ProtocolsListDataSummary objects. */ listProtocolsLists(input: AWS.FMS.ListProtocolsListsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of tags for the specified Amazon Web Services resource. */ listTagsForResource(input: AWS.FMS.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account. */ listThirdPartyFirewallFirewallPolicies(input: AWS.FMS.ListThirdPartyFirewallFirewallPoliciesRequest, options: SdkCallOptions): Promise; /** * Creates an Firewall Manager applications list. */ putAppsList(input: AWS.FMS.PutAppsListRequest, options: SdkCallOptions): Promise; /** * Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager role AWSServiceRoleForFMS to publish SNS logs. For more information, see Firewall Manager required permissions for API actions in the Firewall Manager Developer Guide. */ putNotificationChannel(input: AWS.FMS.PutNotificationChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Creates an Firewall Manager policy. Firewall Manager provides the following types of policies: An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL. An WAF Classic policy (type WAF), which defines a rule group. A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources. A security group policy, which manages VPC security groups across your Amazon Web Services organization. An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs. A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs. Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type. You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription. */ putPolicy(input: AWS.FMS.PutPolicyRequest, options: SdkCallOptions): Promise; /** * Creates an Firewall Manager protocols list. */ putProtocolsList(input: AWS.FMS.PutProtocolsListRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to an Amazon Web Services resource. */ tagResource(input: AWS.FMS.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from an Amazon Web Services resource. */ untagResource(input: AWS.FMS.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface ForecastQueryService { /** * Retrieves a forecast for a single item, filtered by the supplied criteria. The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object. By default, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range. To get the full forecast, use the CreateForecastExportJob operation. The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor. */ queryForecast(input: AWS.ForecastQueryService.QueryForecastRequest, options: SdkCallOptions): Promise; /** * Retrieves a what-if forecast. */ queryWhatIfForecast(input: AWS.ForecastQueryService.QueryWhatIfForecastRequest, options: SdkCallOptions): Promise; } export interface ForecastService { /** * Creates an Amazon Forecast predictor. Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors. Creating new predictors The following parameters are required when creating a new predictor: PredictorName - A unique name for the predictor. DatasetGroupArn - The ARN of the dataset group used to train the predictor. ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc). ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. When creating a new predictor, do not specify a value for ReferencePredictorArn. Upgrading and retraining predictors The following parameters are required when retraining or upgrading a predictor: PredictorName - A unique name for the predictor. ReferencePredictorArn - The ARN of the predictor to retrain or upgrade. When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and PredictorName. */ createAutoPredictor(input: AWS.ForecastService.CreateAutoPredictorRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following: DataFrequency - How frequently your historical time-series data is collected. Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields. Schema - A schema specifies the fields in the dataset, including the field name and data type. After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets. To get a list of all your datasets, use the ListDatasets operation. For example Forecast datasets, see the Amazon Forecast Sample GitHub repository. The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status. */ createDataset(input: AWS.ForecastService.CreateDatasetRequest, options: SdkCallOptions): Promise; /** * Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups. To get a list of all your datasets groups, use the ListDatasetGroups operation. The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation. */ createDatasetGroup(input: AWS.ForecastService.CreateDatasetGroupRequest, options: SdkCallOptions): Promise; /** * Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to. You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see Set up permissions. The training data must be in CSV or Parquet format. The delimiter must be a comma (,). You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files. Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import. To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation. */ createDatasetImportJob(input: AWS.ForecastService.CreateDatasetImportJobRequest, options: SdkCallOptions): Promise; /** * Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor) Creates an Amazon Forecast Explainability. Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values. To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index. CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN. CreateExplainability with a Predictor ARN You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor in CreateAutoPredictor, that predictor already has an Explainability resource. The following parameters are required when providing a Predictor ARN: ExplainabilityName - A unique name for the Explainability. ResourceArn - The Arn of the predictor. TimePointGranularity - Must be set to “ALL”. TimeSeriesGranularity - Must be set to “ALL”. Do not specify a value for the following parameters: DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”. Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”. StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”. EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”. CreateExplainability with a Forecast ARN You can specify a maximum of 50 time series and 500 time points. The following parameters are required when providing a Predictor ARN: ExplainabilityName - A unique name for the Explainability. ResourceArn - The Arn of the forecast. TimePointGranularity - Either “ALL” or “SPECIFIC”. TimeSeriesGranularity - Either “ALL” or “SPECIFIC”. If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following: DataSource - The S3 location of the CSV file specifying your time series. Schema - The Schema defines the attributes and attribute types listed in the Data Source. If you set TimePointGranularity to “SPECIFIC”, you must also provide the following: StartDateTime - The first timestamp in the range of time points. EndDateTime - The last timestamp in the range of time points. */ createExplainability(input: AWS.ForecastService.CreateExplainabilityRequest, options: SdkCallOptions): Promise; /** * Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket. You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation. */ createExplainabilityExport(input: AWS.ForecastService.CreateExplainabilityExportRequest, options: SdkCallOptions): Promise; /** * Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation. The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast. To get a list of all your forecasts, use the ListForecasts operation. The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor. For more information, see howitworks-forecast. The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status. By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values. */ createForecast(input: AWS.ForecastService.CreateForecastRequest, options: SdkCallOptions): Promise; /** * Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions: <ForecastExportJobName>_<ExportTimestamp>_<PartNumber> where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. For more information, see howitworks-forecast. To get a list of all your forecast export jobs, use the ListForecastExportJobs operation. The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation. */ createForecastExportJob(input: AWS.ForecastService.CreateForecastExportJobRequest, options: SdkCallOptions): Promise; /** * Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring. */ createMonitor(input: AWS.ForecastService.CreateMonitorRequest, options: SdkCallOptions): Promise; /** * This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor. Creates an Amazon Forecast predictor. In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters. Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation. To see the evaluation metrics, use the GetAccuracyMetrics operation. You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig. For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups. By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes. AutoML If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult. When AutoML is enabled, the following properties are disallowed: AlgorithmArn HPOConfig PerformHPO TrainingParameters To get a list of all of your predictors, use the ListPredictors operation. Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation. */ createPredictor(input: AWS.ForecastService.CreatePredictorRequest, options: SdkCallOptions): Promise; /** * Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket. The export file names will match the following conventions: <ExportJobName>_<ExportTimestamp>_<PartNumber>.csv The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation. */ createPredictorBacktestExportJob(input: AWS.ForecastService.CreatePredictorBacktestExportJobRequest, options: SdkCallOptions): Promise; /** * What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series. For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals. You could create a scenario where everything is given a 25% markdown and another where everything is given a fixed dollar markdown. You can create a scenario where the sale lasts for 1 week and another where the sale lasts for 1 month. Your what-if analysis enables you to compare many different scenarios against each other. Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good. The TimeSeriesSelector object defines the items that you want in the what-if analysis. */ createWhatIfAnalysis(input: AWS.ForecastService.CreateWhatIfAnalysisRequest, options: SdkCallOptions): Promise; /** * A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset. */ createWhatIfForecast(input: AWS.ForecastService.CreateWhatIfForecastRequest, options: SdkCallOptions): Promise; /** * Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions: ≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber> The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. For more information, see howitworks-forecast. To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation. The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation. */ createWhatIfForecastExport(input: AWS.ForecastService.CreateWhatIfForecastExportRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation. Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup operation, omitting the deleted dataset's ARN. */ deleteDataset(input: AWS.ForecastService.DeleteDatasetRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation. This operation deletes only the dataset group, not the datasets in the group. */ deleteDatasetGroup(input: AWS.ForecastService.DeleteDatasetGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation. */ deleteDatasetImportJob(input: AWS.ForecastService.DeleteDatasetImportJobRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an Explainability resource. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeExplainability operation. */ deleteExplainability(input: AWS.ForecastService.DeleteExplainabilityRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an Explainability export. */ deleteExplainabilityExport(input: AWS.ForecastService.DeleteExplainabilityExportRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation. You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast. */ deleteForecast(input: AWS.ForecastService.DeleteForecastRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation. */ deleteForecastExportJob(input: AWS.ForecastService.DeleteForecastExportJobRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED. */ deleteMonitor(input: AWS.ForecastService.DeleteMonitorRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation. */ deletePredictor(input: AWS.ForecastService.DeletePredictorRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a predictor backtest export job. */ deletePredictorBacktestExportJob(input: AWS.ForecastService.DeletePredictorBacktestExportJobRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an entire resource tree. This operation will delete the parent resource and its child resources. Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource. Amazon Forecast resources possess the following parent-child resource hierarchies: Dataset: dataset import jobs Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs Predictor: predictor backtest export jobs, forecasts, forecast export jobs Forecast: forecast export jobs DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or exported files stored in Amazon S3. */ deleteResourceTree(input: AWS.ForecastService.DeleteResourceTreeRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfAnalysis operation. You can't delete a what-if analysis while any of its forecasts are being exported. */ deleteWhatIfAnalysis(input: AWS.ForecastService.DeleteWhatIfAnalysisRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecast operation. You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis. */ deleteWhatIfForecast(input: AWS.ForecastService.DeleteWhatIfForecastRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecastExport operation. */ deleteWhatIfForecastExport(input: AWS.ForecastService.DeleteWhatIfForecastExportRequest, options: SdkCallOptions): Promise<{}>; /** * Describes a predictor created using the CreateAutoPredictor operation. */ describeAutoPredictor(input: AWS.ForecastService.DescribeAutoPredictorRequest, options: SdkCallOptions): Promise; /** * Describes an Amazon Forecast dataset created using the CreateDataset operation. In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties: CreationTime LastModificationTime Status */ describeDataset(input: AWS.ForecastService.DescribeDatasetRequest, options: SdkCallOptions): Promise; /** * Describes a dataset group created using the CreateDatasetGroup operation. In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties: DatasetArns - The datasets belonging to the group. CreationTime LastModificationTime Status */ describeDatasetGroup(input: AWS.ForecastService.DescribeDatasetGroupRequest, options: SdkCallOptions): Promise; /** * Describes a dataset import job created using the CreateDatasetImportJob operation. In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties: CreationTime LastModificationTime DataSize FieldStatistics Status Message - If an error occurred, information about the error. */ describeDatasetImportJob(input: AWS.ForecastService.DescribeDatasetImportJobRequest, options: SdkCallOptions): Promise; /** * Describes an Explainability resource created using the CreateExplainability operation. */ describeExplainability(input: AWS.ForecastService.DescribeExplainabilityRequest, options: SdkCallOptions): Promise; /** * Describes an Explainability export created using the CreateExplainabilityExport operation. */ describeExplainabilityExport(input: AWS.ForecastService.DescribeExplainabilityExportRequest, options: SdkCallOptions): Promise; /** * Describes a forecast created using the CreateForecast operation. In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties: DatasetGroupArn - The dataset group that provided the training data. CreationTime LastModificationTime Status Message - If an error occurred, information about the error. */ describeForecast(input: AWS.ForecastService.DescribeForecastRequest, options: SdkCallOptions): Promise; /** * Describes a forecast export job created using the CreateForecastExportJob operation. In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties: CreationTime LastModificationTime Status Message - If an error occurred, information about the error. */ describeForecastExportJob(input: AWS.ForecastService.DescribeForecastExportJobRequest, options: SdkCallOptions): Promise; /** * Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties: Baseline CreationTime LastEvaluationTime LastEvaluationState LastModificationTime Message Status */ describeMonitor(input: AWS.ForecastService.DescribeMonitorRequest, options: SdkCallOptions): Promise; /** * This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor. Describes a predictor created using the CreatePredictor operation. In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties: DatasetImportJobArns - The dataset import jobs used to import training data. AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated. CreationTime LastModificationTime Status Message - If an error occurred, information about the error. */ describePredictor(input: AWS.ForecastService.DescribePredictorRequest, options: SdkCallOptions): Promise; /** * Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation. In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties: CreationTime LastModificationTime Status Message (if an error occurred) */ describePredictorBacktestExportJob(input: AWS.ForecastService.DescribePredictorBacktestExportJobRequest, options: SdkCallOptions): Promise; /** * Describes the what-if analysis created using the CreateWhatIfAnalysis operation. In addition to listing the properties provided in the CreateWhatIfAnalysis request, this operation lists the following properties: CreationTime LastModificationTime Message - If an error occurred, information about the error. Status */ describeWhatIfAnalysis(input: AWS.ForecastService.DescribeWhatIfAnalysisRequest, options: SdkCallOptions): Promise; /** * Describes the what-if forecast created using the CreateWhatIfForecast operation. In addition to listing the properties provided in the CreateWhatIfForecast request, this operation lists the following properties: CreationTime LastModificationTime Message - If an error occurred, information about the error. Status */ describeWhatIfForecast(input: AWS.ForecastService.DescribeWhatIfForecastRequest, options: SdkCallOptions): Promise; /** * Describes the what-if forecast export created using the CreateWhatIfForecastExport operation. In addition to listing the properties provided in the CreateWhatIfForecastExport request, this operation lists the following properties: CreationTime LastModificationTime Message - If an error occurred, information about the error. Status */ describeWhatIfForecastExport(input: AWS.ForecastService.DescribeWhatIfForecastExportRequest, options: SdkCallOptions): Promise; /** * Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. For more information, see Predictor Metrics. This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't specified, the number defaults to one. The parameters of the filling method determine which items contribute to the metrics. If you want all items to contribute, specify zero. If you want only those items that have complete data in the range being evaluated to contribute, specify nan. For more information, see FeaturizationMethod. Before you can get accuracy metrics, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation. */ getAccuracyMetrics(input: AWS.ForecastService.GetAccuracyMetricsRequest, options: SdkCallOptions): Promise; /** * Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation. */ listDatasetGroups(input: AWS.ForecastService.ListDatasetGroupsRequest, options: SdkCallOptions): Promise; /** * Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects. */ listDatasetImportJobs(input: AWS.ForecastService.ListDatasetImportJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation. */ listDatasets(input: AWS.ForecastService.ListDatasetsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the DescribeExplainability operation. */ listExplainabilities(input: AWS.ForecastService.ListExplainabilitiesRequest, options: SdkCallOptions): Promise; /** * Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation. */ listExplainabilityExports(input: AWS.ForecastService.ListExplainabilityExportsRequest, options: SdkCallOptions): Promise; /** * Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects. */ listForecastExportJobs(input: AWS.ForecastService.ListForecastExportJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects. */ listForecasts(input: AWS.ForecastService.ListForecastsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time. For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results. */ listMonitorEvaluations(input: AWS.ForecastService.ListMonitorEvaluationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation. */ listMonitors(input: AWS.ForecastService.ListMonitorsRequest, options: SdkCallOptions): Promise; /** * Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation. */ listPredictorBacktestExportJobs(input: AWS.ForecastService.ListPredictorBacktestExportJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can filter the list using an array of Filter objects. */ listPredictors(input: AWS.ForecastService.ListPredictorsRequest, options: SdkCallOptions): Promise; /** * Lists the tags for an Amazon Forecast resource. */ listTagsForResource(input: AWS.ForecastService.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation. */ listWhatIfAnalyses(input: AWS.ForecastService.ListWhatIfAnalysesRequest, options: SdkCallOptions): Promise; /** * Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation. */ listWhatIfForecastExports(input: AWS.ForecastService.ListWhatIfForecastExportsRequest, options: SdkCallOptions): Promise; /** * Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the DescribeWhatIfForecast operation. */ listWhatIfForecasts(input: AWS.ForecastService.ListWhatIfForecastsRequest, options: SdkCallOptions): Promise; /** * Resumes a stopped monitor resource. */ resumeResource(input: AWS.ForecastService.ResumeResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a resource. The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You cannot resume a resource once it has been stopped. This operation can be applied to the following resources (and their corresponding child resources): Dataset Import Job Predictor Job Forecast Job Forecast Export Job Predictor Backtest Export Job Explainability Job Explainability Export Job */ stopResource(input: AWS.ForecastService.StopResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted. */ tagResource(input: AWS.ForecastService.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes the specified tags from a resource. */ untagResource(input: AWS.ForecastService.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Replaces the datasets in a dataset group with the specified datasets. The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status. */ updateDatasetGroup(input: AWS.ForecastService.UpdateDatasetGroupRequest, options: SdkCallOptions): Promise; } export interface FraudDetector { /** * Creates a batch of variables. */ batchCreateVariable(input: AWS.FraudDetector.BatchCreateVariableRequest, options: SdkCallOptions): Promise; /** * Gets a batch of variables. */ batchGetVariable(input: AWS.FraudDetector.BatchGetVariableRequest, options: SdkCallOptions): Promise; /** * Cancels an in-progress batch import job. */ cancelBatchImportJob(input: AWS.FraudDetector.CancelBatchImportJobRequest, options: SdkCallOptions): Promise; /** * Cancels the specified batch prediction job. */ cancelBatchPredictionJob(input: AWS.FraudDetector.CancelBatchPredictionJobRequest, options: SdkCallOptions): Promise; /** * Creates a batch import job. */ createBatchImportJob(input: AWS.FraudDetector.CreateBatchImportJobRequest, options: SdkCallOptions): Promise; /** * Creates a batch prediction job. */ createBatchPredictionJob(input: AWS.FraudDetector.CreateBatchPredictionJobRequest, options: SdkCallOptions): Promise; /** * Creates a detector version. The detector version starts in a DRAFT status. */ createDetectorVersion(input: AWS.FraudDetector.CreateDetectorVersionRequest, options: SdkCallOptions): Promise; /** * Creates a model using the specified model type. */ createModel(input: AWS.FraudDetector.CreateModelRequest, options: SdkCallOptions): Promise; /** * Creates a version of the model using the specified model type and model id. */ createModelVersion(input: AWS.FraudDetector.CreateModelVersionRequest, options: SdkCallOptions): Promise; /** * Creates a rule for use with the specified detector. */ createRule(input: AWS.FraudDetector.CreateRuleRequest, options: SdkCallOptions): Promise; /** * Creates a variable. */ createVariable(input: AWS.FraudDetector.CreateVariableRequest, options: SdkCallOptions): Promise; /** * Deletes the specified batch import job ID record. This action does not delete the data that was batch imported. */ deleteBatchImportJob(input: AWS.FraudDetector.DeleteBatchImportJobRequest, options: SdkCallOptions): Promise; /** * Deletes a batch prediction job. */ deleteBatchPredictionJob(input: AWS.FraudDetector.DeleteBatchPredictionJobRequest, options: SdkCallOptions): Promise; /** * Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector. When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector. */ deleteDetector(input: AWS.FraudDetector.DeleteDetectorRequest, options: SdkCallOptions): Promise; /** * Deletes the detector version. You cannot delete detector versions that are in ACTIVE status. When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector. */ deleteDetectorVersion(input: AWS.FraudDetector.DeleteDetectorVersionRequest, options: SdkCallOptions): Promise; /** * Deletes an entity type. You cannot delete an entity type that is included in an event type. When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector. */ deleteEntityType(input: AWS.FraudDetector.DeleteEntityTypeRequest, options: SdkCallOptions): Promise; /** * Deletes the specified event. When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector. */ deleteEvent(input: AWS.FraudDetector.DeleteEventRequest, options: SdkCallOptions): Promise; /** * Deletes an event type. You cannot delete an event type that is used in a detector or a model. When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector. */ deleteEventType(input: AWS.FraudDetector.DeleteEventTypeRequest, options: SdkCallOptions): Promise; /** * Deletes all events of a particular event type. */ deleteEventsByEventType(input: AWS.FraudDetector.DeleteEventsByEventTypeRequest, options: SdkCallOptions): Promise; /** * Removes a SageMaker model from Amazon Fraud Detector. You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker. */ deleteExternalModel(input: AWS.FraudDetector.DeleteExternalModelRequest, options: SdkCallOptions): Promise; /** * Deletes a label. You cannot delete labels that are included in an event type in Amazon Fraud Detector. You cannot delete a label assigned to an event ID. You must first delete the relevant event ID. When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector. */ deleteLabel(input: AWS.FraudDetector.DeleteLabelRequest, options: SdkCallOptions): Promise; /** * Deletes a model. You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version. When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector. */ deleteModel(input: AWS.FraudDetector.DeleteModelRequest, options: SdkCallOptions): Promise; /** * Deletes a model version. You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version. When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector. */ deleteModelVersion(input: AWS.FraudDetector.DeleteModelVersionRequest, options: SdkCallOptions): Promise; /** * Deletes an outcome. You cannot delete an outcome that is used in a rule version. When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector. */ deleteOutcome(input: AWS.FraudDetector.DeleteOutcomeRequest, options: SdkCallOptions): Promise; /** * Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version. When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector. */ deleteRule(input: AWS.FraudDetector.DeleteRuleRequest, options: SdkCallOptions): Promise; /** * Deletes a variable. You can't delete variables that are included in an event type in Amazon Fraud Detector. Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually. When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector. */ deleteVariable(input: AWS.FraudDetector.DeleteVariableRequest, options: SdkCallOptions): Promise; /** * Gets all versions for a specified detector. */ describeDetector(input: AWS.FraudDetector.DescribeDetectorRequest, options: SdkCallOptions): Promise; /** * Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version. */ describeModelVersions(input: AWS.FraudDetector.DescribeModelVersionsRequest, options: SdkCallOptions): Promise; /** * Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchImportJobsResponse as part of your request. A null pagination token fetches the records from the beginning. */ getBatchImportJobs(input: AWS.FraudDetector.GetBatchImportJobsRequest, options: SdkCallOptions): Promise; /** * Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning. */ getBatchPredictionJobs(input: AWS.FraudDetector.GetBatchPredictionJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves the status of a DeleteEventsByEventType action. */ getDeleteEventsByEventTypeStatus(input: AWS.FraudDetector.GetDeleteEventsByEventTypeStatusRequest, options: SdkCallOptions): Promise; /** * Gets a particular detector version. */ getDetectorVersion(input: AWS.FraudDetector.GetDetectorVersionRequest, options: SdkCallOptions): Promise; /** * Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning. */ getDetectors(input: AWS.FraudDetector.GetDetectorsRequest, options: SdkCallOptions): Promise; /** * Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse as part of your request. A null pagination token fetches the records from the beginning. */ getEntityTypes(input: AWS.FraudDetector.GetEntityTypesRequest, options: SdkCallOptions): Promise; /** * Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results. */ getEvent(input: AWS.FraudDetector.GetEventRequest, options: SdkCallOptions): Promise; /** * Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used. */ getEventPrediction(input: AWS.FraudDetector.GetEventPredictionRequest, options: SdkCallOptions): Promise; /** * Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period. */ getEventPredictionMetadata(input: AWS.FraudDetector.GetEventPredictionMetadataRequest, options: SdkCallOptions): Promise; /** * Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning. */ getEventTypes(input: AWS.FraudDetector.GetEventTypesRequest, options: SdkCallOptions): Promise; /** * Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning. */ getExternalModels(input: AWS.FraudDetector.GetExternalModelsRequest, options: SdkCallOptions): Promise; /** * Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning. */ getLabels(input: AWS.FraudDetector.GetLabelsRequest, options: SdkCallOptions): Promise; /** * Gets the details of the specified model version. */ getModelVersion(input: AWS.FraudDetector.GetModelVersionRequest, options: SdkCallOptions): Promise; /** * Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning. */ getModels(input: AWS.FraudDetector.GetModelsRequest, options: SdkCallOptions): Promise; /** * Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning. */ getOutcomes(input: AWS.FraudDetector.GetOutcomesRequest, options: SdkCallOptions): Promise; /** * Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified. This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning. */ getRules(input: AWS.FraudDetector.GetRulesRequest, options: SdkCallOptions): Promise; /** * Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning. */ getVariables(input: AWS.FraudDetector.GetVariablesRequest, options: SdkCallOptions): Promise; /** * Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned. For example, the following filter lists all past predictions for xyz event type - { "eventType":{ "value": "xyz" }” } This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning. */ listEventPredictions(input: AWS.FraudDetector.ListEventPredictionsRequest, options: SdkCallOptions): Promise; /** * Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning. */ listTagsForResource(input: AWS.FraudDetector.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or updates a detector. */ putDetector(input: AWS.FraudDetector.PutDetectorRequest, options: SdkCallOptions): Promise; /** * Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account. */ putEntityType(input: AWS.FraudDetector.PutEntityTypeRequest, options: SdkCallOptions): Promise; /** * Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications. */ putEventType(input: AWS.FraudDetector.PutEventTypeRequest, options: SdkCallOptions): Promise; /** * Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables. */ putExternalModel(input: AWS.FraudDetector.PutExternalModelRequest, options: SdkCallOptions): Promise; /** * Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector. */ putKMSEncryptionKey(input: AWS.FraudDetector.PutKMSEncryptionKeyRequest, options: SdkCallOptions): Promise; /** * Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector. */ putLabel(input: AWS.FraudDetector.PutLabelRequest, options: SdkCallOptions): Promise; /** * Creates or updates an outcome. */ putOutcome(input: AWS.FraudDetector.PutOutcomeRequest, options: SdkCallOptions): Promise; /** * Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model. */ sendEvent(input: AWS.FraudDetector.SendEventRequest, options: SdkCallOptions): Promise; /** * Assigns tags to a resource. */ tagResource(input: AWS.FraudDetector.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource. */ untagResource(input: AWS.FraudDetector.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version. */ updateDetectorVersion(input: AWS.FraudDetector.UpdateDetectorVersionRequest, options: SdkCallOptions): Promise; /** * Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE). */ updateDetectorVersionMetadata(input: AWS.FraudDetector.UpdateDetectorVersionMetadataRequest, options: SdkCallOptions): Promise; /** * Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE. */ updateDetectorVersionStatus(input: AWS.FraudDetector.UpdateDetectorVersionStatusRequest, options: SdkCallOptions): Promise; /** * Updates the specified event with a new label. */ updateEventLabel(input: AWS.FraudDetector.UpdateEventLabelRequest, options: SdkCallOptions): Promise; /** * Updates model description. */ updateModel(input: AWS.FraudDetector.UpdateModelRequest, options: SdkCallOptions): Promise; /** * Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03. */ updateModelVersion(input: AWS.FraudDetector.UpdateModelVersionRequest, options: SdkCallOptions): Promise; /** * Updates the status of a model version. You can perform the following status updates: Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED. Change the TRAINING_COMPLETE status to ACTIVE. Change ACTIVE to INACTIVE. */ updateModelVersionStatus(input: AWS.FraudDetector.UpdateModelVersionStatusRequest, options: SdkCallOptions): Promise; /** * Updates a rule's metadata. The description attribute can be updated. */ updateRuleMetadata(input: AWS.FraudDetector.UpdateRuleMetadataRequest, options: SdkCallOptions): Promise; /** * Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...). */ updateRuleVersion(input: AWS.FraudDetector.UpdateRuleVersionRequest, options: SdkCallOptions): Promise; /** * Updates a variable. */ updateVariable(input: AWS.FraudDetector.UpdateVariableRequest, options: SdkCallOptions): Promise; } export interface FSx { /** * Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias. The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system. */ associateFileSystemAliases(input: AWS.FSx.AssociateFileSystemAliasesRequest, options: SdkCallOptions): Promise; /** * Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following. Any files that FSx has already exported are not reverted. FSx continues to export any files that are "in-flight" when the cancel operation is received. FSx does not export any files that have not yet been exported. */ cancelDataRepositoryTask(input: AWS.FSx.CancelDataRepositoryTaskRequest, options: SdkCallOptions): Promise; /** * Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account. You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions). You can also use backup copies to clone your file dataset to another Region or within the same Region. You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy). For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide. */ copyBackup(input: AWS.FSx.CopyBackupRequest, options: SdkCallOptions): Promise; /** * Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume. For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration: A Persistent deployment type Are not linked to a data repository For more information about backups, see the following: For Amazon FSx for Lustre, see Working with FSx for Lustre backups. For Amazon FSx for Windows, see Working with FSx for Windows backups. For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups. For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups. If a backup with the specified client request token exists and the parameters match, this operation returns the description of the existing backup. If a backup with the specified client request token exists and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following: Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the backup. By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same. The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information. */ createBackup(input: AWS.FSx.CreateBackupRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported only for file systems with the Persistent_2 deployment type. Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket. CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation. */ createDataRepositoryAssociation(input: AWS.FSx.CreateDataRepositoryAssociationRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket. */ createDataRepositoryTask(input: AWS.FSx.CreateDataRepositoryTaskRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon File Cache resource. You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following: Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the cache in JSON format. The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information. */ createFileCache(input: AWS.FSx.CreateFileCacheRequest, options: SdkCallOptions): Promise; /** * Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation: Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following: Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system in JSON format. The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. */ createFileSystem(input: AWS.FSx.CreateFileSystemRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup. If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following: Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the file system. Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings. By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same. The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. */ createFileSystemFromBackup(input: AWS.FSx.CreateFileSystemFromBackupRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version. If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following: Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the snapshot. By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same. The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information. */ createSnapshot(input: AWS.FSx.CreateSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system. */ createStorageVirtualMachine(input: AWS.FSx.CreateStorageVirtualMachineRequest, options: SdkCallOptions): Promise; /** * Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume. */ createVolume(input: AWS.FSx.CreateVolumeRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup. */ createVolumeFromBackup(input: AWS.FSx.CreateVolumeFromBackupRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone. The DeleteBackup call returns instantly. The backup won't show up in later DescribeBackups calls. The data in a deleted backup is also deleted and can't be recovered by any means. */ deleteBackup(input: AWS.FSx.DeleteBackupRequest, options: SdkCallOptions): Promise; /** * Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported only for file systems with the Persistent_2 deployment type. */ deleteDataRepositoryAssociation(input: AWS.FSx.DeleteDataRepositoryAssociationRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone. The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error. The data in a deleted cache is also deleted and can't be recovered by any means. */ deleteFileCache(input: AWS.FSx.DeleteFileCacheRequest, options: SdkCallOptions): Promise; /** * Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted. To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a FileSystemId value to the DeleFileSystem operation. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted. The DeleteFileSystem operation returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems operation returns a FileSystemNotFound error. If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request). The data in a deleted file system is also deleted and can't be recovered by any means. */ deleteFileSystem(input: AWS.FSx.DeleteFileSystemRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup. The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete. */ deleteSnapshot(input: AWS.FSx.DeleteSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail. */ deleteStorageVirtualMachine(input: AWS.FSx.DeleteStorageVirtualMachineRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. */ deleteVolume(input: AWS.FSx.DeleteVolumeRequest, options: SdkCallOptions): Promise; /** * Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of the NextToken value from the last response. This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value. When using this operation, keep the following in mind: The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value. The order of the backups returned in the response of one DescribeBackups call and the order of the backups returned across the responses of a multi-call iteration is unspecified. */ describeBackups(input: AWS.FSx.DescribeBackupsRequest, options: SdkCallOptions): Promise; /** * Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported only for Amazon FSx for Lustre file systems with the Persistent_2 deployment type and for Amazon File Cache resources. You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. */ describeDataRepositoryAssociations(input: AWS.FSx.DescribeDataRepositoryAssociationsRequest, options: SdkCallOptions): Promise; /** * Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. */ describeDataRepositoryTasks(input: AWS.FSx.DescribeDataRepositoryTasksRequest, options: SdkCallOptions): Promise; /** * Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this operation, keep the following in mind: The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value. The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified. */ describeFileCaches(input: AWS.FSx.DescribeFileCachesRequest, options: SdkCallOptions): Promise; /** * Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response. */ describeFileSystemAliases(input: AWS.FSx.DescribeFileSystemAliasesRequest, options: SdkCallOptions): Promise; /** * Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this operation, keep the following in mind: The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value. The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified. */ describeFileSystems(input: AWS.FSx.DescribeFileSystemsRequest, options: SdkCallOptions): Promise; /** * Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value. When using this operation, keep the following in mind: The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value. The order of snapshots returned in the response of one DescribeSnapshots call and the order of backups returned across the responses of a multi-call iteration is unspecified. */ describeSnapshots(input: AWS.FSx.DescribeSnapshotsRequest, options: SdkCallOptions): Promise; /** * Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). */ describeStorageVirtualMachines(input: AWS.FSx.DescribeStorageVirtualMachinesRequest, options: SdkCallOptions): Promise; /** * Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. */ describeVolumes(input: AWS.FSx.DescribeVolumesRequest, options: SdkCallOptions): Promise; /** * Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases. The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system. */ disassociateFileSystemAliases(input: AWS.FSx.DisassociateFileSystemAliasesRequest, options: SdkCallOptions): Promise; /** * Lists tags for Amazon FSx resources. When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind: The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value. The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified. */ listTagsForResource(input: AWS.FSx.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Releases the file system lock from an Amazon FSx for OpenZFS file system. */ releaseFileSystemNfsV3Locks(input: AWS.FSx.ReleaseFileSystemNfsV3LocksRequest, options: SdkCallOptions): Promise; /** * Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot. */ restoreVolumeFromSnapshot(input: AWS.FSx.RestoreVolumeFromSnapshotRequest, options: SdkCallOptions): Promise; /** * Tags an Amazon FSx resource. */ tagResource(input: AWS.FSx.TagResourceRequest, options: SdkCallOptions): Promise; /** * This action removes a tag from an Amazon FSx resource. */ untagResource(input: AWS.FSx.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported only for file systems with the Persistent_2 deployment type. */ updateDataRepositoryAssociation(input: AWS.FSx.UpdateDataRepositoryAssociationRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request. */ updateFileCache(input: AWS.FSx.UpdateFileCacheRequest, options: SdkCallOptions): Promise; /** * Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For Amazon FSx for Windows File Server file systems, you can update the following properties: AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For Amazon FSx for Lustre file systems, you can update the following properties: AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType LustreRootSquashConfiguration StorageCapacity WeeklyMaintenanceStartTime For Amazon FSx for NetApp ONTAP file systems, you can update the following properties: AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration FsxAdminPassword StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For the Amazon FSx for OpenZFS file systems, you can update the following properties: AutomaticBackupRetentionDays CopyTagsToBackups CopyTagsToVolumes DailyAutomaticBackupStartTime ThroughputCapacity WeeklyMaintenanceStartTime */ updateFileSystem(input: AWS.FSx.UpdateFileSystemRequest, options: SdkCallOptions): Promise; /** * Updates the name of an Amazon FSx for OpenZFS snapshot. */ updateSnapshot(input: AWS.FSx.UpdateSnapshotRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon FSx for ONTAP storage virtual machine (SVM). */ updateStorageVirtualMachine(input: AWS.FSx.UpdateStorageVirtualMachineRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. */ updateVolume(input: AWS.FSx.UpdateVolumeRequest, options: SdkCallOptions): Promise; } export interface GameLift { /** * Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit. When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error. To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match. If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more players rejected the match or failed to respond, the ticket status is set to CANCELLED, and processing is terminated. For tickets where players have accepted or not yet responded, the ticket status is returned to SEARCHING to find a new match. A new matchmaking request for these players can be submitted as needed. Learn more Add FlexMatch to a game client FlexMatch events (reference) Related actions StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task */ acceptMatch(input: AWS.GameLift.AcceptMatchInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ locates an available game server, places it in CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server. To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED (using UpdateGameServer) once players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable. If you try to claim a specific game server, this request will fail in the following cases: If the game server utilization status is UTILIZED. If the game server claim status is CLAIMED. When claiming a specific game server, this request will succeed even if the game server is running on an instance in DRAINING status. To avoid this, first check the instance status by calling DescribeGameServerInstances. Learn more GameLift FleetIQ Guide Related actions RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task */ claimGameServer(input: AWS.GameLift.ClaimGameServerInput, options: SdkCallOptions): Promise; /** * Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site. To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias. Related actions CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task */ createAlias(input: AWS.GameLift.CreateAliasInput, options: SdkCallOptions): Promise; /** * Creates a new Amazon GameLift build resource for your game server binary files. Game server binaries must be combined into a zip file for use with Amazon GameLift. When setting up a new game build for GameLift, we recommend using the Amazon Web Services CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource. The CreateBuild operation can used in the following scenarios: To create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you must first give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, call CreateBuild and specify a build name, operating system, and the Amazon S3 storage location of your game build. To directly upload your build files to a GameLift Amazon S3 location. To use this option, first call CreateBuild and specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. Build files can be uploaded to the GameLift Amazon S3 location once only; that can't be updated. If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it. Learn more Uploading Your Game Create a Build with Files in Amazon S3 Related actions CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task */ createBuild(input: AWS.GameLift.CreateBuildInput, options: SdkCallOptions): Promise; /** * Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance. Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location. To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations. If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. If successful, this operation creates a new Fleet resource and places it in NEW status, which prompts GameLift to initiate the fleet creation workflow. You can track fleet creation by checking fleet status using DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by monitoring fleet creation events using DescribeFleetEvents. As soon as the fleet status changes to ACTIVE, you can enable automatic scaling for the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. When the status of each remote location reaches ACTIVE, you can set capacity by location using UpdateFleetCapacity. Learn more Setting up fleets Debug fleet creation issues Multi-location fleets Related actions CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task */ createFleet(input: AWS.GameLift.CreateFleetInput, options: SdkCallOptions): Promise; /** * Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings. This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature (see CreateFleet for the complete list) and were created after the feature was released in March 2021. To add fleet locations, specify the fleet to be updated and provide a list of one or more locations. If successful, this operation returns the list of added locations with their status set to NEW. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents. Alternatively, you can poll location status by calling DescribeFleetLocationAttributes. After a location status becomes ACTIVE, you can adjust the location's capacity as needed with UpdateFleetCapacity. Learn more Setting up fleets Multi-location fleets Related actions CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task */ createFleetLocations(input: AWS.GameLift.CreateFleetLocationsInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch. Before creating a new game server group, you must have the following: An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide. An IAM role that extends limited access to your Amazon Web Services account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide. To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric. Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost. Learn more GameLift FleetIQ Guide Related actions CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task */ createGameServerGroup(input: AWS.GameLift.CreateGameServerGroupInput, options: SdkCallOptions): Promise; /** * Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the GameLift game session placement feature with with StartGameSessionPlacement, which uses FleetIQ algorithms and queues to optimize the placement process. When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in ACTIVE status before a game session can be created in it. This operation can be used in the following ways: To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration. To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration. If successful, a workflow is initiated to start a new game session. A GameSession object is returned containing the game session configuration and status. When the status is ACTIVE, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy. Game session logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files. Available in Amazon GameLift Local. Learn more Start a game session Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ createGameSession(input: AWS.GameLift.CreateGameSessionInput, options: SdkCallOptions): Promise; /** * Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session. A game session queue is configured with a set of destinations (GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed. The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities. To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity. If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN. Learn more Design a game session queue Create a game session queue Related actions CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task */ createGameSessionQueue(input: AWS.GameLift.CreateGameSessionQueueInput, options: SdkCallOptions): Promise; /** * Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify the matchmaking configuration to use and provide player attributes consistent with that configuration. To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match. In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. An alternative method, continuously polling ticket status with DescribeMatchmaking, is only suitable for games in development with low matchmaking usage. Learn more Design a FlexMatch matchmaker Set up FlexMatch event notification Related actions CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task */ createMatchmakingConfiguration(input: AWS.GameLift.CreateMatchmakingConfigurationInput, options: SdkCallOptions): Promise; /** * Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a MatchmakingConfiguration. To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with. Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set. Learn more Build a rule set Design a matchmaker Matchmaking with FlexMatch Related actions CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task */ createMatchmakingRuleSet(input: AWS.GameLift.CreateMatchmakingRuleSetInput, options: SdkCallOptions): Promise; /** * Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. You can add a group of players to a game session with CreatePlayerSessions. To create a player session, specify a game session ID, player ID, and optionally a set of player data. If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated. The maximum number of players per game session is 200. It is not adjustable. Available in Amazon GameLift Local. Related actions CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task */ createPlayerSession(input: AWS.GameLift.CreatePlayerSessionInput, options: SdkCallOptions): Promise; /** * Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession. To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID. If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated. The maximum number of players per game session is 200. It is not adjustable. Available in Amazon GameLift Local. Related actions CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task */ createPlayerSessions(input: AWS.GameLift.CreatePlayerSessionsInput, options: SdkCallOptions): Promise; /** * Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations: A locally available directory. Use the ZipFile parameter for this option. An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket. If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment. Learn more Amazon GameLift Realtime Servers Set Up a Role for Amazon GameLift Access Related actions CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task */ createScript(input: AWS.GameLift.CreateScriptInput, options: SdkCallOptions): Promise; /** * Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. Once you've received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets. You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC. To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift. The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid. Related actions CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task */ createVpcPeeringAuthorization(input: AWS.GameLift.CreateVpcPeeringAuthorizationInput, options: SdkCallOptions): Promise; /** * Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets. Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents. Related actions CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task */ createVpcPeeringConnection(input: AWS.GameLift.CreateVpcPeeringConnectionInput, options: SdkCallOptions): Promise; /** * Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted. Related actions CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task */ deleteAlias(input: AWS.GameLift.DeleteAliasInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build. To delete a build, specify the build ID. Learn more Upload a Custom Server Build Related actions CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task */ deleteBuild(input: AWS.GameLift.DeleteBuildInput, options: SdkCallOptions): Promise<{}>; /** * Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to call DeleteFleetLocations separately. If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection--this is done as part of the delete fleet process. To delete a fleet, specify the fleet ID to be terminated. During the deletion process the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is sent. Learn more Setting up GameLift Fleets Related actions CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task */ deleteFleet(input: AWS.GameLift.DeleteFleetInput, options: SdkCallOptions): Promise<{}>; /** * Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down. To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted. If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED. Learn more Setting up GameLift fleets Related actions CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task */ deleteFleetLocations(input: AWS.GameLift.DeleteFleetLocationsInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources: The game server group The corresponding Auto Scaling group All game servers that are currently running in the group To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status. If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status. GameLift FleetIQ emits delete events to Amazon CloudWatch. Learn more GameLift FleetIQ Guide Related actions CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task */ deleteGameServerGroup(input: AWS.GameLift.DeleteGameServerGroupInput, options: SdkCallOptions): Promise; /** * Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name. Learn more Using Multi-Region Queues Related actions CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task */ deleteGameSessionQueue(input: AWS.GameLift.DeleteGameSessionQueueInput, options: SdkCallOptions): Promise; /** * Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets. Related actions CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task */ deleteMatchmakingConfiguration(input: AWS.GameLift.DeleteMatchmakingConfigurationInput, options: SdkCallOptions): Promise; /** * Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration. Learn more Build a rule set Related actions CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task */ deleteMatchmakingRuleSet(input: AWS.GameLift.DeleteMatchmakingRuleSetInput, options: SdkCallOptions): Promise; /** * Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with. To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet. Related actions DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task */ deleteScalingPolicy(input: AWS.GameLift.DeleteScalingPolicyInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted). To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions. Learn more Amazon GameLift Realtime Servers Related actions CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task */ deleteScript(input: AWS.GameLift.DeleteScriptInput, options: SdkCallOptions): Promise<{}>; /** * Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, call DeleteVpcPeeringConnection. Related actions CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task */ deleteVpcPeeringAuthorization(input: AWS.GameLift.DeleteVpcPeeringAuthorizationInput, options: SdkCallOptions): Promise; /** * Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization. Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed. Related actions CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task */ deleteVpcPeeringConnection(input: AWS.GameLift.DeleteVpcPeeringConnectionInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers. To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason. Learn more GameLift FleetIQ Guide Related actions RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task */ deregisterGameServer(input: AWS.GameLift.DeregisterGameServerInput, options: SdkCallOptions): Promise<{}>; /** * Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias. To get alias properties, specify the alias ID. If successful, the requested alias record is returned. Related actions CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task */ describeAlias(input: AWS.GameLift.DescribeAliasInput, options: SdkCallOptions): Promise; /** * Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned. Learn more Upload a Custom Server Build Related actions CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task */ describeBuild(input: AWS.GameLift.DescribeBuildInput, options: SdkCallOptions): Promise; /** * Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console. Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results: Request specifies the Region ap-northeast-1 with no location. The result is limits and usage data on all instance types that are deployed in us-east-2, by all of the fleets that reside in ap-northeast-1. Request specifies the Region us-east-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1. Request specifies the Region eu-west-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in eu-west-1. This operation can be used in the following ways: To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for. To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for. If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type. Learn more Setting up GameLift fleets Related actions CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task */ describeEC2InstanceLimits(input: AWS.GameLift.DescribeEC2InstanceLimitsInput, options: SdkCallOptions): Promise; /** * Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet. This operation can be used in the following ways: To get attributes for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. To get attributes for all fleets, do not provide a fleet identifier. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found. Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number. Learn more Setting up GameLift fleets Related actions ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task */ describeFleetAttributes(input: AWS.GameLift.DescribeFleetAttributesInput, options: SdkCallOptions): Promise; /** * Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationCapacity to get capacity settings for a fleet's remote locations. This operation can be used in the following ways: To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. To get capacity data for all fleets, do not provide a fleet identifier. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist. Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Setting up GameLift fleets GameLift metrics for fleets Related actions ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task */ describeFleetCapacity(input: AWS.GameLift.DescribeFleetCapacityInput, options: SdkCallOptions): Promise; /** * Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned. Learn more Setting up GameLift fleets Related actions ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task */ describeFleetEvents(input: AWS.GameLift.DescribeFleetEventsInput, options: SdkCallOptions): Promise; /** * Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity. This operation can be used in the following ways: To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested. To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order. When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes. Learn more Setting up GameLift fleets Related actions CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task */ describeFleetLocationAttributes(input: AWS.GameLift.DescribeFleetLocationAttributesInput, options: SdkCallOptions): Promise; /** * Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity). To retrieve capacity data, identify a fleet and location. If successful, a FleetCapacity object is returned for the requested fleet location. Learn more Setting up GameLift fleets GameLift metrics for fleets Related actions CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task */ describeFleetLocationCapacity(input: AWS.GameLift.DescribeFleetLocationCapacityInput, options: SdkCallOptions): Promise; /** * Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization). To retrieve utilization data, identify a fleet and location. If successful, a FleetUtilization object is returned for the requested fleet location. Learn more Setting up GameLift fleets GameLift metrics for fleets Related actions CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task */ describeFleetLocationUtilization(input: AWS.GameLift.DescribeFleetLocationUtilizationInput, options: SdkCallOptions): Promise; /** * Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range. This operation can be used in the following ways: To retrieve the inbound connection permissions for a fleet, identify the fleet's unique identifier. To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations. If successful, a set of IpPermission objects is returned for the requested fleet ID. When a location is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty. Learn more Setting up GameLift fleets Related actions ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task */ describeFleetPortSettings(input: AWS.GameLift.DescribeFleetPortSettingsInput, options: SdkCallOptions): Promise; /** * Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations. This operation can be used in the following ways: To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. To get utilization data for all fleets, do not provide a fleet identifier. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region. Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. Learn more Setting up GameLift Fleets GameLift Metrics for Fleets Related actions ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task */ describeFleetUtilization(input: AWS.GameLift.DescribeFleetUtilizationInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on. To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned. Learn more GameLift FleetIQ Guide Related actions RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task */ describeGameServer(input: AWS.GameLift.DescribeGameServerInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Retrieves information on a game server group. This operation returns only properties related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly. To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned. Learn more GameLift FleetIQ Guide Related actions CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task */ describeGameServerGroup(input: AWS.GameLift.DescribeGameServerGroupInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. If you are looking for instance configuration information, call DescribeGameServerGroup or access the corresponding Auto Scaling group properties. To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned. This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds. Learn more GameLift FleetIQ Guide Related actions CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task */ describeGameServerInstances(input: AWS.GameLift.DescribeGameServerInstancesInput, options: SdkCallOptions): Promise; /** * Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve all game session properties, use DescribeGameSessions. This operation can be used in the following ways: To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations. To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location. To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each game session that matches the request. Learn more Find a game session Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ describeGameSessionDetails(input: AWS.GameLift.DescribeGameSessionDetailsInput, options: SdkCallOptions): Promise; /** * Retrieves information, including current status, about a game session placement request. To get game session placement details, specify the placement ID. This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage. If successful, a GameSessionPlacement object is returned. Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ describeGameSessionPlacement(input: AWS.GameLift.DescribeGameSessionPlacementInput, options: SdkCallOptions): Promise; /** * Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region. Learn more View Your Queues Related actions CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task */ describeGameSessionQueues(input: AWS.GameLift.DescribeGameSessionQueuesInput, options: SdkCallOptions): Promise; /** * Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve the protection policy for game sessions, use DescribeGameSessionDetails. This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessions should only be used for games in development with low game session usage. This operation can be used in the following ways: To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations. To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location. To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session that matches the request. This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with DescribeGameSessions should only be used for games in development with low matchmaking usage. Available in Amazon GameLift Local. Learn more Find a game session Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ describeGameSessions(input: AWS.GameLift.DescribeGameSessionsInput, options: SdkCallOptions): Promise; /** * Retrieves information about a fleet's instances, including instance IDs, connection data, and status. This operation can be used in the following ways: To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID. To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name. To get information on a specific instance in a fleet, provide the fleet ID and instance ID. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each requested instance. Instances are not returned in any particular order. Learn more Remotely Access Fleet Instances Debug Fleet Issues Related actions DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task */ describeInstances(input: AWS.GameLift.DescribeInstancesInput, options: SdkCallOptions): Promise; /** * Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session. To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists. This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously polling ticket status with DescribeMatchmaking should only be used for games in development with low matchmaking usage. Learn more Add FlexMatch to a game client Set Up FlexMatch event notification Related actions StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task */ describeMatchmaking(input: AWS.GameLift.DescribeMatchmakingInput, options: SdkCallOptions): Promise; /** * Retrieves the details of FlexMatch matchmaking configurations. This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned. Learn more Setting up FlexMatch matchmakers Related actions CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task */ describeMatchmakingConfigurations(input: AWS.GameLift.DescribeMatchmakingConfigurationsInput, options: SdkCallOptions): Promise; /** * Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name. Learn more Build a rule set Related actions CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task */ describeMatchmakingRuleSets(input: AWS.GameLift.DescribeMatchmakingRuleSetsInput, options: SdkCallOptions): Promise; /** * Retrieves properties for one or more player sessions. This action can be used in the following ways: To retrieve a specific player session, provide the player session ID only. To retrieve all player sessions in a game session, provide the game session ID only. To retrieve all player sessions for a specific player, provide a player ID only. To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session that matches the request. Available in Amazon GameLift Local. Related actions CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task */ describePlayerSessions(input: AWS.GameLift.DescribePlayerSessionsInput, options: SdkCallOptions): Promise; /** * Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet. To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID. If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty. Learn more Setting up GameLift fleets Running multiple processes on a fleet Related actions ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task */ describeRuntimeConfiguration(input: AWS.GameLift.DescribeRuntimeConfigurationInput, options: SdkCallOptions): Promise; /** * Retrieves all scaling policies applied to a fleet. To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet. A fleet may have all of its scaling policies suspended (StopFleetActions). This operation does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions. Related actions DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task */ describeScalingPolicies(input: AWS.GameLift.DescribeScalingPoliciesInput, options: SdkCallOptions): Promise; /** * Retrieves properties for a Realtime script. To request a script record, specify the script ID. If successful, an object containing the script properties is returned. Learn more Amazon GameLift Realtime Servers Related actions CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task */ describeScript(input: AWS.GameLift.DescribeScriptInput, options: SdkCallOptions): Promise; /** * Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. Related actions CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task */ describeVpcPeeringAuthorizations(input: AWS.GameLift.DescribeVpcPeeringAuthorizationsInput, options: SdkCallOptions): Promise; /** * Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect. Related actions CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task */ describeVpcPeeringConnections(input: AWS.GameLift.DescribeVpcPeeringConnectionsInput, options: SdkCallOptions): Promise; /** * Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs. See the Amazon Web Services Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved. Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ getGameSessionLogUrl(input: AWS.GameLift.GetGameSessionLogUrlInput, options: SdkCallOptions): Promise; /** * Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time. To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation. To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned that contains the instance's IP address and a set of credentials. Learn more Remotely Access Fleet Instances Debug Fleet Issues Related actions DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task */ getInstanceAccess(input: AWS.GameLift.GetInstanceAccessInput, options: SdkCallOptions): Promise; /** * Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages. Returned aliases are not listed in any particular order. Related actions CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task */ listAliases(input: AWS.GameLift.ListAliasesInput, options: SdkCallOptions): Promise; /** * Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages. Build resources are not listed in any particular order. Learn more Upload a Custom Server Build Related actions CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task */ listBuilds(input: AWS.GameLift.ListBuildsInput, options: SdkCallOptions): Promise; /** * Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only. This operation can be used in the following ways: To get a list of all fleets in a Region, don't provide a build or script identifier. To get a list of all fleets where a specific custom game build is deployed, provide the build ID. To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve. Fleet resources are not listed in a particular order. Learn more Setting up GameLift fleets Related actions CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task */ listFleets(input: AWS.GameLift.ListFleetsInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Retrieves information on all game servers groups that exist in the current Amazon Web Services account for the selected Region. Use the pagination parameters to retrieve results in a set of sequential segments. Learn more GameLift FleetIQ Guide Related actions CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task */ listGameServerGroups(input: AWS.GameLift.ListGameServerGroupsInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments. Learn more GameLift FleetIQ Guide Related actions RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task */ listGameServers(input: AWS.GameLift.ListGameServersInput, options: SdkCallOptions): Promise; /** * Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use. Learn more Amazon GameLift Realtime Servers Related actions CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task */ listScripts(input: AWS.GameLift.ListScriptsInput, options: SdkCallOptions): Promise; /** * Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types: Build Script Fleet Alias GameSessionQueue MatchmakingConfiguration MatchmakingRuleSet To list tags for a resource, specify the unique ARN value for the resource. Learn more Tagging Amazon Web Services Resources in the Amazon Web Services General Reference Amazon Web Services Tagging Strategies Related actions TagResource | UntagResource | ListTagsForResource | All APIs by task */ listTagsForResource(input: AWS.GameLift.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences. You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy. Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling. Target-based policy A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target. For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer. To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. Rule-based policy A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%." A policy's rule statement has the following structure: If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment]. To implement the example, the rule statement would look like this: If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10]. To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. Related actions DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task */ putScalingPolicy(input: AWS.GameLift.PutScalingPolicyInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session. To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data. When a game client or service requests a game server by calling ClaimGameServer, this information is returned in the response. Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity. Learn more GameLift FleetIQ Guide Related actions RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task */ registerGameServer(input: AWS.GameLift.RegisterGameServerInput, options: SdkCallOptions): Promise; /** * Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild. To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID. Learn more Create a Build with Files in S3 Related actions CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task */ requestUploadCredentials(input: AWS.GameLift.RequestUploadCredentialsInput, options: SdkCallOptions): Promise; /** * Retrieves the fleet ID that an alias is currently pointing to. Related actions CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task */ resolveAlias(input: AWS.GameLift.ResolveAliasInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by theSuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended. To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions. Learn more GameLift FleetIQ Guide Related actions CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task */ resumeGameServerGroup(input: AWS.GameLift.ResumeGameServerGroupInput, options: SdkCallOptions): Promise; /** * Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order. This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling game session status with DescribeGameSessions should only be used for games in development with low game session usage. When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations. This operation can be used in the following ways: To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria. To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session that matches the request. Search finds game sessions that are in ACTIVE status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions. You can search or sort by the following game session attributes: gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value. gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session. gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl". All custom data values are searched as strings. maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds. playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out. hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join. Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ searchGameSessions(input: AWS.GameLift.SearchGameSessionsInput, options: SdkCallOptions): Promise; /** * Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity. This operation can be used in the following ways: To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume. To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume. If successful, GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. Learn more Setting up GameLift fleets Related actions CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task */ startFleetActions(input: AWS.GameLift.StartFleetActionsInput, options: SdkCallOptions): Promise; /** * Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out. A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request. When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order. Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players. To place a new game session request, specify the following: The queue name and a set of game session properties and settings A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request (Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player) Latency data for all players (if you want to optimize game play for the players) If successful, a new game session placement is created. To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue. Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ startGameSessionPlacement(input: AWS.GameLift.StartGameSessionPlacementInput, options: SdkCallOptions): Promise; /** * Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements. When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSession identifier. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request. When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled. To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches. Only game sessions created by FlexMatch are supported for match backfill. Learn more Backfill existing games with FlexMatch Matchmaking events (reference) How GameLift FlexMatch works Related actions StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task */ startMatchBackfill(input: AWS.GameLift.StartMatchBackfillInput, options: SdkCallOptions): Promise; /** * Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match. To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to QUEUED. Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration. Learn more Add FlexMatch to a game client Set Up FlexMatch event notification How GameLift FlexMatch works Related actions StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task */ startMatchmaking(input: AWS.GameLift.StartMatchmakingInput, options: SdkCallOptions): Promise; /** * Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location. Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations. This operation can be used in the following ways: To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend. To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend. If successful, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended activity can be restarted using StartFleetActions. Learn more Setting up GameLift Fleets Related actions CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task */ stopFleetActions(input: AWS.GameLift.StopFleetActionsInput, options: SdkCallOptions): Promise; /** * Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status. Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ stopGameSessionPlacement(input: AWS.GameLift.StopGameSessionPlacementInput, options: SdkCallOptions): Promise; /** * Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED. This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server. If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body). Learn more Add FlexMatch to a game client Related actions StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task */ stopMatchmaking(input: AWS.GameLift.StopMatchmakingInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity: Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active. To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions. Learn more GameLift FleetIQ Guide Related actions CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task */ suspendGameServerGroup(input: AWS.GameLift.SuspendGameServerGroupInput, options: SdkCallOptions): Promise; /** * Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types: Build Script Fleet Alias GameSessionQueue MatchmakingConfiguration MatchmakingRuleSet To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource. Learn more Tagging Amazon Web Services Resources in the Amazon Web Services General Reference Amazon Web Services Tagging Strategies Related actions TagResource | UntagResource | ListTagsForResource | All APIs by task */ tagResource(input: AWS.GameLift.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types: Build Script Fleet Alias GameSessionQueue MatchmakingConfiguration MatchmakingRuleSet To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource. Learn more Tagging Amazon Web Services Resources in the Amazon Web Services General Reference Amazon Web Services Tagging Strategies Related actions TagResource | UntagResource | ListTagsForResource | All APIs by task */ untagResource(input: AWS.GameLift.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned. Related actions CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task */ updateAlias(input: AWS.GameLift.UpdateAliasInput, options: SdkCallOptions): Promise; /** * Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned. Learn more Upload a Custom Server Build Related actions CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task */ updateBuild(input: AWS.GameLift.UpdateBuildInput, options: SdkCallOptions): Promise; /** * Updates a fleet's mutable attributes, including game session protection and resource creation limits. To update fleet attributes, specify the fleet ID and the property values that you want to change. If successful, an updated FleetAttributes object is returned. Learn more Setting up GameLift fleets Related actions CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task */ updateFleetAttributes(input: AWS.GameLift.UpdateFleetAttributesInput, options: SdkCallOptions): Promise; /** * Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties: Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling. Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand. This operation can be used in the following ways: To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status. To update capacity for a fleet's remote location, include the Location parameter set to the location to be updated. The location must be in ACTIVE status. If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's limit, the LimitExceeded exception occurs. Learn more Scaling fleet capacity Related actions CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task */ updateFleetCapacity(input: AWS.GameLift.UpdateFleetCapacityInput, options: SdkCallOptions): Promise; /** * Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in the fleet. To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name. Learn more Setting up GameLift fleets Related actions CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task */ updateFleetPortSettings(input: AWS.GameLift.UpdateFleetPortSettingsInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Updates information about a registered game server to help GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group. Use this operation to update the following types of game server information. You can make all three types of updates in the same request: To update the game server's utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed. To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds. To change game server metadata, provide updated game server data. Once a game server is successfully updated, the relevant statuses and timestamps are updated. Learn more GameLift FleetIQ Guide Related actions RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task */ updateGameServer(input: AWS.GameLift.UpdateGameServerInput, options: SdkCallOptions): Promise; /** * This operation is used with the GameLift FleetIQ solution and game server groups. Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts. To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned. Learn more GameLift FleetIQ Guide Related actions CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task */ updateGameServerGroup(input: AWS.GameLift.UpdateGameServerGroupInput, options: SdkCallOptions): Promise; /** * Updates the mutable properties of a game session. To update a game session, specify the game session ID and the values you want to change. If successful, the updated GameSession object is returned. Related actions CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task */ updateGameSession(input: AWS.GameLift.UpdateGameSessionInput, options: SdkCallOptions): Promise; /** * Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations. Learn more Using Multi-Region Queues Related actions CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task */ updateGameSessionQueue(input: AWS.GameLift.UpdateGameSessionQueueInput, options: SdkCallOptions): Promise; /** * Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings. Learn more Design a FlexMatch matchmaker Related actions CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task */ updateMatchmakingConfiguration(input: AWS.GameLift.UpdateMatchmakingConfigurationInput, options: SdkCallOptions): Promise; /** * Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on all instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status. To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations. If successful, the fleet's runtime configuration settings are updated. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes. Learn more Setting up GameLift fleets Related actions CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task */ updateRuntimeConfiguration(input: AWS.GameLift.UpdateRuntimeConfigurationInput, options: SdkCallOptions): Promise; /** * Updates Realtime script metadata and content. To update script metadata, specify the script ID and provide updated name and/or version values. To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script. If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions. Learn more Amazon GameLift Realtime Servers Related actions CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task */ updateScript(input: AWS.GameLift.UpdateScriptInput, options: SdkCallOptions): Promise; /** * Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string. Learn more Build a rule set Related actions CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task */ validateMatchmakingRuleSet(input: AWS.GameLift.ValidateMatchmakingRuleSetInput, options: SdkCallOptions): Promise; } export interface GameSparks { /** * Creates a new game with an empty configuration. After creating your game, you can update the configuration using UpdateGameConfiguration or ImportGameConfiguration. */ createGame(input: AWS.GameSparks.CreateGameRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of the game configuration. */ createSnapshot(input: AWS.GameSparks.CreateSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates a new stage for stage-by-stage game development and deployment. */ createStage(input: AWS.GameSparks.CreateStageRequest, options: SdkCallOptions): Promise; /** * Deletes a game. */ deleteGame(input: AWS.GameSparks.DeleteGameRequest, options: SdkCallOptions): Promise; /** * Deletes a stage from a game, along with the associated game runtime. */ deleteStage(input: AWS.GameSparks.DeleteStageRequest, options: SdkCallOptions): Promise; /** * Disconnects a player from the game runtime. If a player has multiple connections, this operation attempts to close all of them. */ disconnectPlayer(input: AWS.GameSparks.DisconnectPlayerRequest, options: SdkCallOptions): Promise; /** * Exports a game configuration snapshot. */ exportSnapshot(input: AWS.GameSparks.ExportSnapshotRequest, options: SdkCallOptions): Promise; /** * Gets details about a specified extension. */ getExtension(input: AWS.GameSparks.GetExtensionRequest, options: SdkCallOptions): Promise; /** * Gets details about a specified extension version. */ getExtensionVersion(input: AWS.GameSparks.GetExtensionVersionRequest, options: SdkCallOptions): Promise; /** * Gets details about a game. */ getGame(input: AWS.GameSparks.GetGameRequest, options: SdkCallOptions): Promise; /** * Gets the configuration of the game. */ getGameConfiguration(input: AWS.GameSparks.GetGameConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets details about a job that is generating code for a snapshot. */ getGeneratedCodeJob(input: AWS.GameSparks.GetGeneratedCodeJobRequest, options: SdkCallOptions): Promise; /** * Gets the status of a player's connection to the game runtime. It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list. */ getPlayerConnectionStatus(input: AWS.GameSparks.GetPlayerConnectionStatusRequest, options: SdkCallOptions): Promise; /** * Gets a copy of the game configuration in a snapshot. */ getSnapshot(input: AWS.GameSparks.GetSnapshotRequest, options: SdkCallOptions): Promise; /** * Gets information about a stage. */ getStage(input: AWS.GameSparks.GetStageRequest, options: SdkCallOptions): Promise; /** * Gets information about a stage deployment. */ getStageDeployment(input: AWS.GameSparks.GetStageDeploymentRequest, options: SdkCallOptions): Promise; /** * Imports a game configuration. This operation replaces the current configuration of the game with the provided input. This is not a reversible operation. If you want to preserve the previous configuration, use CreateSnapshot to make a new snapshot before importing. */ importGameConfiguration(input: AWS.GameSparks.ImportGameConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets a paginated list of available versions for the extension. Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available. */ listExtensionVersions(input: AWS.GameSparks.ListExtensionVersionsRequest, options: SdkCallOptions): Promise; /** * Gets a paginated list of available extensions. Extensions provide features that games can use from scripts. */ listExtensions(input: AWS.GameSparks.ListExtensionsRequest, options: SdkCallOptions): Promise; /** * Gets a paginated list of games. */ listGames(input: AWS.GameSparks.ListGamesRequest, options: SdkCallOptions): Promise; /** * Gets a paginated list of code generation jobs for a snapshot. */ listGeneratedCodeJobs(input: AWS.GameSparks.ListGeneratedCodeJobsRequest, options: SdkCallOptions): Promise; /** * Gets a paginated list of snapshot summaries from the game. */ listSnapshots(input: AWS.GameSparks.ListSnapshotsRequest, options: SdkCallOptions): Promise; /** * Gets a paginated list of stage deployment summaries from the game. */ listStageDeployments(input: AWS.GameSparks.ListStageDeploymentsRequest, options: SdkCallOptions): Promise; /** * Gets a paginated list of stage summaries from the game. */ listStages(input: AWS.GameSparks.ListStagesRequest, options: SdkCallOptions): Promise; /** * Lists the tags associated with a GameSparks resource. */ listTagsForResource(input: AWS.GameSparks.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL. */ startGeneratedCodeJob(input: AWS.GameSparks.StartGeneratedCodeJobRequest, options: SdkCallOptions): Promise; /** * Deploys a snapshot to the stage and creates a new game runtime. After you call this operation, you can check the deployment status by using GetStageDeployment. If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted. */ startStageDeployment(input: AWS.GameSparks.StartStageDeploymentRequest, options: SdkCallOptions): Promise; /** * Adds tags to a GameSparks resource. */ tagResource(input: AWS.GameSparks.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a GameSparks resource. */ untagResource(input: AWS.GameSparks.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates details of the game. */ updateGame(input: AWS.GameSparks.UpdateGameRequest, options: SdkCallOptions): Promise; /** * Updates one or more sections of the game configuration. */ updateGameConfiguration(input: AWS.GameSparks.UpdateGameConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the metadata of a GameSparks snapshot. */ updateSnapshot(input: AWS.GameSparks.UpdateSnapshotRequest, options: SdkCallOptions): Promise; /** * Updates the metadata of a stage. */ updateStage(input: AWS.GameSparks.UpdateStageRequest, options: SdkCallOptions): Promise; } export interface Glacier { /** * This operation aborts a multipart upload identified by the upload ID. After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload. This operation is idempotent. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Working with Archives in Amazon S3 Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide. */ abortMultipartUpload(input: AWS.Glacier.AbortMultipartUploadInput, options: SdkCallOptions): Promise<{}>; /** * This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault. A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies. This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault. */ abortVaultLock(input: AWS.Glacier.AbortVaultLockInput, options: SdkCallOptions): Promise<{}>; /** * This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon S3 Glacier Resources. */ addTagsToVault(input: AWS.Glacier.AddTagsToVaultInput, options: SdkCallOptions): Promise<{}>; /** * You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob. In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue. Additionally, Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Glacier returns an error and the operation fails. Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide. */ completeMultipartUpload(input: AWS.Glacier.CompleteMultipartUploadInput, options: SdkCallOptions): Promise; /** * This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault. If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error. */ completeVaultLock(input: AWS.Glacier.CompleteVaultLockInput, options: SdkCallOptions): Promise<{}>; /** * This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon S3 Glacier. You must use the following guidelines when naming a vault. Names can be between 1 and 255 characters long. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). This operation is idempotent. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide. */ createVault(input: AWS.Glacier.CreateVaultInput, options: SdkCallOptions): Promise; /** * This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios: If the archive retrieval job is actively preparing the data for download when Amazon S3 Glacier receives the delete archive request, the archival retrieval operation might fail. If the archive retrieval job has successfully prepared the archive for download when Amazon S3 Glacier receives the delete archive request, you will be able to download the output. This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide. */ deleteArchive(input: AWS.Glacier.DeleteArchiveInput, options: SdkCallOptions): Promise<{}>; /** * This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive). This operation is idempotent. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon S3 Glacier Developer Guide. */ deleteVault(input: AWS.Glacier.DeleteVaultInput, options: SdkCallOptions): Promise<{}>; /** * This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request. This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies. */ deleteVaultAccessPolicy(input: AWS.Glacier.DeleteVaultAccessPolicyInput, options: SdkCallOptions): Promise<{}>; /** * This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Delete Vault Notification Configuration in the Amazon S3 Glacier Developer Guide. */ deleteVaultNotifications(input: AWS.Glacier.DeleteVaultNotificationsInput, options: SdkCallOptions): Promise<{}>; /** * This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more information about initiating a job, see InitiateJob. This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Glacier can notify the topic after it completes the job. A job ID will not expire for at least 24 hours after Glacier completes the job. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide. */ describeJob(input: AWS.Glacier.DescribeJobInput, options: SdkCallOptions): Promise; /** * This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon S3 Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon S3 Glacier. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and Describe Vault in the Amazon Glacier Developer Guide. */ describeVault(input: AWS.Glacier.DescribeVaultInput, options: SdkCallOptions): Promise; /** * This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies. */ getDataRetrievalPolicy(input: AWS.Glacier.GetDataRetrievalPolicyInput, options: SdkCallOptions): Promise; /** * This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory. You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data. A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response. For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response. In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected. A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output */ getJobOutput(input: AWS.Glacier.GetJobOutputInput, options: SdkCallOptions): Promise; /** * This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies. */ getVaultAccessPolicy(input: AWS.Glacier.GetVaultAccessPolicyInput, options: SdkCallOptions): Promise; /** * This operation retrieves the following attributes from the lock-policy subresource set on the specified vault: The vault lock policy set on the vault. The state of the vault lock, which is either InProgess or Locked. When the lock ID expires. The lock ID is used to complete the vault locking process. When the vault lock was initiated and put into the InProgress state. A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies. */ getVaultLock(input: AWS.Glacier.GetVaultLockInput, options: SdkCallOptions): Promise; /** * This operation retrieves the notification-configuration subresource of the specified vault. For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon S3 Glacier. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide. */ getVaultNotifications(input: AWS.Glacier.GetVaultNotificationsInput, options: SdkCallOptions): Promise; /** * This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job. */ initiateJob(input: AWS.Glacier.InitiateJobInput, options: SdkCallOptions): Promise; /** * This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart). When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB. Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. You don't need to know the size of the archive when you start a multipart upload because Amazon S3 Glacier does not require you to specify the overall archive size. After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload resource referenced by the ID. Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide. */ initiateMultipartUpload(input: AWS.Glacier.InitiateMultipartUploadInput, options: SdkCallOptions): Promise; /** * This operation initiates the vault locking process by doing the following: Installing a vault lock policy on the specified vault. Setting the lock state of vault lock to InProgress. Returning a lock ID, which is used to complete the vault locking process. You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies. You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked. After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault. You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock. If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy. */ initiateVaultLock(input: AWS.Glacier.InitiateVaultLockInput, options: SdkCallOptions): Promise; /** * This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time. Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists. The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request. You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit. Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true) or jobs that were not completed (false). For more information about using this operation, see the documentation for the underlying REST API List Jobs. */ listJobs(input: AWS.Glacier.ListJobsInput, options: SdkCallOptions): Promise; /** * This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request. Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide. */ listMultipartUploads(input: AWS.Glacier.ListMultipartUploadsInput, options: SdkCallOptions): Promise; /** * This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Parts in the Amazon Glacier Developer Guide. */ listParts(input: AWS.Glacier.ListPartsInput, options: SdkCallOptions): Promise; /** * This operation lists the provisioned capacity units for the specified AWS account. */ listProvisionedCapacity(input: AWS.Glacier.ListProvisionedCapacityInput, options: SdkCallOptions): Promise; /** * This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon S3 Glacier Resources. */ listTagsForVault(input: AWS.Glacier.ListTagsForVaultInput, options: SdkCallOptions): Promise; /** * This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. By default, this operation returns up to 10 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and List Vaults in the Amazon Glacier Developer Guide. */ listVaults(input: AWS.Glacier.ListVaultsInput, options: SdkCallOptions): Promise; /** * This operation purchases a provisioned capacity unit for an AWS account. */ purchaseProvisionedCapacity(input: AWS.Glacier.PurchaseProvisionedCapacityInput, options: SdkCallOptions): Promise; /** * This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon S3 Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault. */ removeTagsFromVault(input: AWS.Glacier.RemoveTagsFromVaultInput, options: SdkCallOptions): Promise<{}>; /** * This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation. The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies. */ setDataRetrievalPolicy(input: AWS.Glacier.SetDataRetrievalPolicyInput, options: SdkCallOptions): Promise<{}>; /** * This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies. */ setVaultAccessPolicy(input: AWS.Glacier.SetVaultAccessPolicyInput, options: SdkCallOptions): Promise<{}>; /** * This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon S3 Glacier to send notifications to the topic. Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events: ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob. InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide. */ setVaultNotifications(input: AWS.Glacier.SetVaultNotificationsInput, options: SdkCallOptions): Promise<{}>; /** * This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in the x-amz-archive-id header of the response. You must use the archive ID to access your data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob. You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums. You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. Archives are immutable. After you upload an archive, you cannot edit the archive or its description. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide. */ uploadArchive(input: AWS.Glacier.UploadArchiveInput, options: SdkCallOptions): Promise; /** * This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload. Amazon Glacier rejects your upload part request if any of the following conditions is true: SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums. Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size. If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail. Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data. An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide. */ uploadMultipartPart(input: AWS.Glacier.UploadMultipartPartInput, options: SdkCallOptions): Promise; } export interface GlobalAccelerator { /** * Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator. The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports. Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException. By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation. */ addCustomRoutingEndpoints(input: AWS.GlobalAccelerator.AddCustomRoutingEndpointsRequest, options: SdkCallOptions): Promise; /** * Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays. To stop advertising the BYOIP address range, use WithdrawByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. */ advertiseByoipCidr(input: AWS.GlobalAccelerator.AdvertiseByoipCidrRequest, options: SdkCallOptions): Promise; /** * Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group. After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED. */ allowCustomRoutingTraffic(input: AWS.GlobalAccelerator.AllowCustomRoutingTrafficRequest, options: SdkCallOptions): Promise<{}>; /** * Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands. */ createAccelerator(input: AWS.GlobalAccelerator.CreateAcceleratorRequest, options: SdkCallOptions): Promise; /** * Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints. Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands. */ createCustomRoutingAccelerator(input: AWS.GlobalAccelerator.CreateCustomRoutingAcceleratorRequest, options: SdkCallOptions): Promise; /** * Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region. */ createCustomRoutingEndpointGroup(input: AWS.GlobalAccelerator.CreateCustomRoutingEndpointGroupRequest, options: SdkCallOptions): Promise; /** * Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify. */ createCustomRoutingListener(input: AWS.GlobalAccelerator.CreateCustomRoutingListenerRequest, options: SdkCallOptions): Promise; /** * Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint. */ createEndpointGroup(input: AWS.GlobalAccelerator.CreateEndpointGroupRequest, options: SdkCallOptions): Promise; /** * Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. */ createListener(input: AWS.GlobalAccelerator.CreateListenerRequest, options: SdkCallOptions): Promise; /** * Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false. When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide. */ deleteAccelerator(input: AWS.GlobalAccelerator.DeleteAcceleratorRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false. When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide. */ deleteCustomRoutingAccelerator(input: AWS.GlobalAccelerator.DeleteCustomRoutingAcceleratorRequest, options: SdkCallOptions): Promise<{}>; /** * Delete an endpoint group from a listener for a custom routing accelerator. */ deleteCustomRoutingEndpointGroup(input: AWS.GlobalAccelerator.DeleteCustomRoutingEndpointGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a listener for a custom routing accelerator. */ deleteCustomRoutingListener(input: AWS.GlobalAccelerator.DeleteCustomRoutingListenerRequest, options: SdkCallOptions): Promise<{}>; /** * Delete an endpoint group from a listener. */ deleteEndpointGroup(input: AWS.GlobalAccelerator.DeleteEndpointGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a listener from an accelerator. */ deleteListener(input: AWS.GlobalAccelerator.DeleteListenerRequest, options: SdkCallOptions): Promise<{}>; /** * Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group. After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED. */ denyCustomRoutingTraffic(input: AWS.GlobalAccelerator.DenyCustomRoutingTrafficRequest, options: SdkCallOptions): Promise<{}>; /** * Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. */ deprovisionByoipCidr(input: AWS.GlobalAccelerator.DeprovisionByoipCidrRequest, options: SdkCallOptions): Promise; /** * Describe an accelerator. */ describeAccelerator(input: AWS.GlobalAccelerator.DescribeAcceleratorRequest, options: SdkCallOptions): Promise; /** * Describe the attributes of an accelerator. */ describeAcceleratorAttributes(input: AWS.GlobalAccelerator.DescribeAcceleratorAttributesRequest, options: SdkCallOptions): Promise; /** * Describe a custom routing accelerator. */ describeCustomRoutingAccelerator(input: AWS.GlobalAccelerator.DescribeCustomRoutingAcceleratorRequest, options: SdkCallOptions): Promise; /** * Describe the attributes of a custom routing accelerator. */ describeCustomRoutingAcceleratorAttributes(input: AWS.GlobalAccelerator.DescribeCustomRoutingAcceleratorAttributesRequest, options: SdkCallOptions): Promise; /** * Describe an endpoint group for a custom routing accelerator. */ describeCustomRoutingEndpointGroup(input: AWS.GlobalAccelerator.DescribeCustomRoutingEndpointGroupRequest, options: SdkCallOptions): Promise; /** * The description of a listener for a custom routing accelerator. */ describeCustomRoutingListener(input: AWS.GlobalAccelerator.DescribeCustomRoutingListenerRequest, options: SdkCallOptions): Promise; /** * Describe an endpoint group. */ describeEndpointGroup(input: AWS.GlobalAccelerator.DescribeEndpointGroupRequest, options: SdkCallOptions): Promise; /** * Describe a listener. */ describeListener(input: AWS.GlobalAccelerator.DescribeListenerRequest, options: SdkCallOptions): Promise; /** * List the accelerators for an Amazon Web Services account. */ listAccelerators(input: AWS.GlobalAccelerator.ListAcceleratorsRequest, options: SdkCallOptions): Promise; /** * Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes. */ listByoipCidrs(input: AWS.GlobalAccelerator.ListByoipCidrsRequest, options: SdkCallOptions): Promise; /** * List the custom routing accelerators for an Amazon Web Services account. */ listCustomRoutingAccelerators(input: AWS.GlobalAccelerator.ListCustomRoutingAcceleratorsRequest, options: SdkCallOptions): Promise; /** * List the endpoint groups that are associated with a listener for a custom routing accelerator. */ listCustomRoutingEndpointGroups(input: AWS.GlobalAccelerator.ListCustomRoutingEndpointGroupsRequest, options: SdkCallOptions): Promise; /** * List the listeners for a custom routing accelerator. */ listCustomRoutingListeners(input: AWS.GlobalAccelerator.ListCustomRoutingListenersRequest, options: SdkCallOptions): Promise; /** * Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers. If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator. The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic. */ listCustomRoutingPortMappings(input: AWS.GlobalAccelerator.ListCustomRoutingPortMappingsRequest, options: SdkCallOptions): Promise; /** * List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance. */ listCustomRoutingPortMappingsByDestination(input: AWS.GlobalAccelerator.ListCustomRoutingPortMappingsByDestinationRequest, options: SdkCallOptions): Promise; /** * List the endpoint groups that are associated with a listener. */ listEndpointGroups(input: AWS.GlobalAccelerator.ListEndpointGroupsRequest, options: SdkCallOptions): Promise; /** * List the listeners for an accelerator. */ listListeners(input: AWS.GlobalAccelerator.ListListenersRequest, options: SdkCallOptions): Promise; /** * List all tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide. */ listTagsForResource(input: AWS.GlobalAccelerator.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. */ provisionByoipCidr(input: AWS.GlobalAccelerator.ProvisionByoipCidrRequest, options: SdkCallOptions): Promise; /** * Remove endpoints from a custom routing accelerator. */ removeCustomRoutingEndpoints(input: AWS.GlobalAccelerator.RemoveCustomRoutingEndpointsRequest, options: SdkCallOptions): Promise<{}>; /** * Add tags to an accelerator resource. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide. */ tagResource(input: AWS.GlobalAccelerator.TagResourceRequest, options: SdkCallOptions): Promise; /** * Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide. */ untagResource(input: AWS.GlobalAccelerator.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update an accelerator. Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands. */ updateAccelerator(input: AWS.GlobalAccelerator.UpdateAcceleratorRequest, options: SdkCallOptions): Promise; /** * Update the attributes for an accelerator. */ updateAcceleratorAttributes(input: AWS.GlobalAccelerator.UpdateAcceleratorAttributesRequest, options: SdkCallOptions): Promise; /** * Update a custom routing accelerator. */ updateCustomRoutingAccelerator(input: AWS.GlobalAccelerator.UpdateCustomRoutingAcceleratorRequest, options: SdkCallOptions): Promise; /** * Update the attributes for a custom routing accelerator. */ updateCustomRoutingAcceleratorAttributes(input: AWS.GlobalAccelerator.UpdateCustomRoutingAcceleratorAttributesRequest, options: SdkCallOptions): Promise; /** * Update a listener for a custom routing accelerator. */ updateCustomRoutingListener(input: AWS.GlobalAccelerator.UpdateCustomRoutingListenerRequest, options: SdkCallOptions): Promise; /** * Update an endpoint group. A resource must be valid and active when you add it as an endpoint. */ updateEndpointGroup(input: AWS.GlobalAccelerator.UpdateEndpointGroupRequest, options: SdkCallOptions): Promise; /** * Update a listener. */ updateListener(input: AWS.GlobalAccelerator.UpdateListenerRequest, options: SdkCallOptions): Promise; /** * Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide. */ withdrawByoipCidr(input: AWS.GlobalAccelerator.WithdrawByoipCidrRequest, options: SdkCallOptions): Promise; } export interface Glue { /** * Creates one or more partitions in a batch operation. */ batchCreatePartition(input: AWS.Glue.BatchCreatePartitionRequest, options: SdkCallOptions): Promise; /** * Deletes a list of connection definitions from the Data Catalog. */ batchDeleteConnection(input: AWS.Glue.BatchDeleteConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes one or more partitions in a batch operation. */ batchDeletePartition(input: AWS.Glue.BatchDeletePartitionRequest, options: SdkCallOptions): Promise; /** * Deletes multiple tables at once. After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure the immediate deletion of all related resources, before calling BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table. */ batchDeleteTable(input: AWS.Glue.BatchDeleteTableRequest, options: SdkCallOptions): Promise; /** * Deletes a specified batch of versions of a table. */ batchDeleteTableVersion(input: AWS.Glue.BatchDeleteTableVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a list of blueprints. */ batchGetBlueprints(input: AWS.Glue.BatchGetBlueprintsRequest, options: SdkCallOptions): Promise; /** * Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. */ batchGetCrawlers(input: AWS.Glue.BatchGetCrawlersRequest, options: SdkCallOptions): Promise; /** * Retrieves the details for the custom patterns specified by a list of names. */ batchGetCustomEntityTypes(input: AWS.Glue.BatchGetCustomEntityTypesRequest, options: SdkCallOptions): Promise; /** * Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. */ batchGetDevEndpoints(input: AWS.Glue.BatchGetDevEndpointsRequest, options: SdkCallOptions): Promise; /** * Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. */ batchGetJobs(input: AWS.Glue.BatchGetJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves partitions in a batch request. */ batchGetPartition(input: AWS.Glue.BatchGetPartitionRequest, options: SdkCallOptions): Promise; /** * Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. */ batchGetTriggers(input: AWS.Glue.BatchGetTriggersRequest, options: SdkCallOptions): Promise; /** * Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. */ batchGetWorkflows(input: AWS.Glue.BatchGetWorkflowsRequest, options: SdkCallOptions): Promise; /** * Stops one or more job runs for a specified job definition. */ batchStopJobRun(input: AWS.Glue.BatchStopJobRunRequest, options: SdkCallOptions): Promise; /** * Updates one or more partitions in a batch operation. */ batchUpdatePartition(input: AWS.Glue.BatchUpdatePartitionRequest, options: SdkCallOptions): Promise; /** * Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun with a task run's parent transform's TransformID and the task run's TaskRunId. */ cancelMLTaskRun(input: AWS.Glue.CancelMLTaskRunRequest, options: SdkCallOptions): Promise; /** * Cancels the statement. */ cancelStatement(input: AWS.Glue.CancelStatementRequest, options: SdkCallOptions): Promise; /** * Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat as the format. Since it does not take a schema set name, no compatibility checks are performed. */ checkSchemaVersionValidity(input: AWS.Glue.CheckSchemaVersionValidityInput, options: SdkCallOptions): Promise; /** * Registers a blueprint with Glue. */ createBlueprint(input: AWS.Glue.CreateBlueprintRequest, options: SdkCallOptions): Promise; /** * Creates a classifier in the user's account. This can be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present. */ createClassifier(input: AWS.Glue.CreateClassifierRequest, options: SdkCallOptions): Promise; /** * Creates a connection definition in the Data Catalog. */ createConnection(input: AWS.Glue.CreateConnectionRequest, options: SdkCallOptions): Promise; /** * Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field. */ createCrawler(input: AWS.Glue.CreateCrawlerRequest, options: SdkCallOptions): Promise; /** * Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data. Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked. */ createCustomEntityType(input: AWS.Glue.CreateCustomEntityTypeRequest, options: SdkCallOptions): Promise; /** * Creates a new database in a Data Catalog. */ createDatabase(input: AWS.Glue.CreateDatabaseRequest, options: SdkCallOptions): Promise; /** * Creates a new development endpoint. */ createDevEndpoint(input: AWS.Glue.CreateDevEndpointRequest, options: SdkCallOptions): Promise; /** * Creates a new job definition. */ createJob(input: AWS.Glue.CreateJobRequest, options: SdkCallOptions): Promise; /** * Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it. Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches transform) for deduplicating data. You can provide an optional Description, in addition to the parameters that you want to use for your algorithm. You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include Role, and optionally, AllocatedCapacity, Timeout, and MaxRetries. For more information, see Jobs. */ createMLTransform(input: AWS.Glue.CreateMLTransformRequest, options: SdkCallOptions): Promise; /** * Creates a new partition. */ createPartition(input: AWS.Glue.CreatePartitionRequest, options: SdkCallOptions): Promise; /** * Creates a specified partition index in an existing table. */ createPartitionIndex(input: AWS.Glue.CreatePartitionIndexRequest, options: SdkCallOptions): Promise; /** * Creates a new registry which may be used to hold a collection of schemas. */ createRegistry(input: AWS.Glue.CreateRegistryInput, options: SdkCallOptions): Promise; /** * Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version. When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion API is used. When this API is called without a RegistryId, this will create an entry for a "default-registry" in the registry database tables, if it is not already present. */ createSchema(input: AWS.Glue.CreateSchemaInput, options: SdkCallOptions): Promise; /** * Transforms a directed acyclic graph (DAG) into code. */ createScript(input: AWS.Glue.CreateScriptRequest, options: SdkCallOptions): Promise; /** * Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints. */ createSecurityConfiguration(input: AWS.Glue.CreateSecurityConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a new session. */ createSession(input: AWS.Glue.CreateSessionRequest, options: SdkCallOptions): Promise; /** * Creates a new table definition in the Data Catalog. */ createTable(input: AWS.Glue.CreateTableRequest, options: SdkCallOptions): Promise; /** * Creates a new trigger. */ createTrigger(input: AWS.Glue.CreateTriggerRequest, options: SdkCallOptions): Promise; /** * Creates a new function definition in the Data Catalog. */ createUserDefinedFunction(input: AWS.Glue.CreateUserDefinedFunctionRequest, options: SdkCallOptions): Promise; /** * Creates a new workflow. */ createWorkflow(input: AWS.Glue.CreateWorkflowRequest, options: SdkCallOptions): Promise; /** * Deletes an existing blueprint. */ deleteBlueprint(input: AWS.Glue.DeleteBlueprintRequest, options: SdkCallOptions): Promise; /** * Removes a classifier from the Data Catalog. */ deleteClassifier(input: AWS.Glue.DeleteClassifierRequest, options: SdkCallOptions): Promise; /** * Delete the partition column statistics of a column. The Identity and Access Management (IAM) permission required for this operation is DeletePartition. */ deleteColumnStatisticsForPartition(input: AWS.Glue.DeleteColumnStatisticsForPartitionRequest, options: SdkCallOptions): Promise; /** * Retrieves table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is DeleteTable. */ deleteColumnStatisticsForTable(input: AWS.Glue.DeleteColumnStatisticsForTableRequest, options: SdkCallOptions): Promise; /** * Deletes a connection from the Data Catalog. */ deleteConnection(input: AWS.Glue.DeleteConnectionRequest, options: SdkCallOptions): Promise; /** * Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING. */ deleteCrawler(input: AWS.Glue.DeleteCrawlerRequest, options: SdkCallOptions): Promise; /** * Deletes a custom pattern by specifying its name. */ deleteCustomEntityType(input: AWS.Glue.DeleteCustomEntityTypeRequest, options: SdkCallOptions): Promise; /** * Removes a specified database from a Data Catalog. After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure the immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database. */ deleteDatabase(input: AWS.Glue.DeleteDatabaseRequest, options: SdkCallOptions): Promise; /** * Deletes a specified development endpoint. */ deleteDevEndpoint(input: AWS.Glue.DeleteDevEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes a specified job definition. If the job definition is not found, no exception is thrown. */ deleteJob(input: AWS.Glue.DeleteJobRequest, options: SdkCallOptions): Promise; /** * Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms. However, any Glue jobs that still reference the deleted transform will no longer succeed. */ deleteMLTransform(input: AWS.Glue.DeleteMLTransformRequest, options: SdkCallOptions): Promise; /** * Deletes a specified partition. */ deletePartition(input: AWS.Glue.DeletePartitionRequest, options: SdkCallOptions): Promise; /** * Deletes a specified partition index from an existing table. */ deletePartitionIndex(input: AWS.Glue.DeletePartitionIndexRequest, options: SdkCallOptions): Promise; /** * Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs. */ deleteRegistry(input: AWS.Glue.DeleteRegistryInput, options: SdkCallOptions): Promise; /** * Deletes a specified policy. */ deleteResourcePolicy(input: AWS.Glue.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs. */ deleteSchema(input: AWS.Glue.DeleteSchemaInput, options: SdkCallOptions): Promise; /** * Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions. When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API. You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. */ deleteSchemaVersions(input: AWS.Glue.DeleteSchemaVersionsInput, options: SdkCallOptions): Promise; /** * Deletes a specified security configuration. */ deleteSecurityConfiguration(input: AWS.Glue.DeleteSecurityConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the session. */ deleteSession(input: AWS.Glue.DeleteSessionRequest, options: SdkCallOptions): Promise; /** * Removes a table definition from the Data Catalog. After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure the immediate deletion of all related resources, before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table. */ deleteTable(input: AWS.Glue.DeleteTableRequest, options: SdkCallOptions): Promise; /** * Deletes a specified version of a table. */ deleteTableVersion(input: AWS.Glue.DeleteTableVersionRequest, options: SdkCallOptions): Promise; /** * Deletes a specified trigger. If the trigger is not found, no exception is thrown. */ deleteTrigger(input: AWS.Glue.DeleteTriggerRequest, options: SdkCallOptions): Promise; /** * Deletes an existing function definition from the Data Catalog. */ deleteUserDefinedFunction(input: AWS.Glue.DeleteUserDefinedFunctionRequest, options: SdkCallOptions): Promise; /** * Deletes a workflow. */ deleteWorkflow(input: AWS.Glue.DeleteWorkflowRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a blueprint. */ getBlueprint(input: AWS.Glue.GetBlueprintRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a blueprint run. */ getBlueprintRun(input: AWS.Glue.GetBlueprintRunRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of blueprint runs for a specified blueprint. */ getBlueprintRuns(input: AWS.Glue.GetBlueprintRunsRequest, options: SdkCallOptions): Promise; /** * Retrieves the status of a migration operation. */ getCatalogImportStatus(input: AWS.Glue.GetCatalogImportStatusRequest, options: SdkCallOptions): Promise; /** * Retrieve a classifier by name. */ getClassifier(input: AWS.Glue.GetClassifierRequest, options: SdkCallOptions): Promise; /** * Lists all classifier objects in the Data Catalog. */ getClassifiers(input: AWS.Glue.GetClassifiersRequest, options: SdkCallOptions): Promise; /** * Retrieves partition statistics of columns. The Identity and Access Management (IAM) permission required for this operation is GetPartition. */ getColumnStatisticsForPartition(input: AWS.Glue.GetColumnStatisticsForPartitionRequest, options: SdkCallOptions): Promise; /** * Retrieves table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is GetTable. */ getColumnStatisticsForTable(input: AWS.Glue.GetColumnStatisticsForTableRequest, options: SdkCallOptions): Promise; /** * Retrieves a connection definition from the Data Catalog. */ getConnection(input: AWS.Glue.GetConnectionRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of connection definitions from the Data Catalog. */ getConnections(input: AWS.Glue.GetConnectionsRequest, options: SdkCallOptions): Promise; /** * Retrieves metadata for a specified crawler. */ getCrawler(input: AWS.Glue.GetCrawlerRequest, options: SdkCallOptions): Promise; /** * Retrieves metrics about specified crawlers. */ getCrawlerMetrics(input: AWS.Glue.GetCrawlerMetricsRequest, options: SdkCallOptions): Promise; /** * Retrieves metadata for all crawlers defined in the customer account. */ getCrawlers(input: AWS.Glue.GetCrawlersRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a custom pattern by specifying its name. */ getCustomEntityType(input: AWS.Glue.GetCustomEntityTypeRequest, options: SdkCallOptions): Promise; /** * Retrieves the security configuration for a specified catalog. */ getDataCatalogEncryptionSettings(input: AWS.Glue.GetDataCatalogEncryptionSettingsRequest, options: SdkCallOptions): Promise; /** * Retrieves the definition of a specified database. */ getDatabase(input: AWS.Glue.GetDatabaseRequest, options: SdkCallOptions): Promise; /** * Retrieves all databases defined in a given Data Catalog. */ getDatabases(input: AWS.Glue.GetDatabasesRequest, options: SdkCallOptions): Promise; /** * Transforms a Python script into a directed acyclic graph (DAG). */ getDataflowGraph(input: AWS.Glue.GetDataflowGraphRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a specified development endpoint. When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address. */ getDevEndpoint(input: AWS.Glue.GetDevEndpointRequest, options: SdkCallOptions): Promise; /** * Retrieves all the development endpoints in this AWS account. When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address. */ getDevEndpoints(input: AWS.Glue.GetDevEndpointsRequest, options: SdkCallOptions): Promise; /** * Retrieves an existing job definition. */ getJob(input: AWS.Glue.GetJobRequest, options: SdkCallOptions): Promise; /** * Returns information on a job bookmark entry. */ getJobBookmark(input: AWS.Glue.GetJobBookmarkRequest, options: SdkCallOptions): Promise; /** * Retrieves the metadata for a given job run. */ getJobRun(input: AWS.Glue.GetJobRunRequest, options: SdkCallOptions): Promise; /** * Retrieves metadata for all runs of a given job definition. */ getJobRuns(input: AWS.Glue.GetJobRunsRequest, options: SdkCallOptions): Promise; /** * Retrieves all current job definitions. */ getJobs(input: AWS.Glue.GetJobsRequest, options: SdkCallOptions): Promise; /** * Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun with the TaskRunID and its parent transform's TransformID. */ getMLTaskRun(input: AWS.Glue.GetMLTaskRunRequest, options: SdkCallOptions): Promise; /** * Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform's TransformID and other optional parameters as documented in this section. This operation returns a list of historic runs and must be paginated. */ getMLTaskRuns(input: AWS.Glue.GetMLTaskRunsRequest, options: SdkCallOptions): Promise; /** * Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform. */ getMLTransform(input: AWS.Glue.GetMLTransformRequest, options: SdkCallOptions): Promise; /** * Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling GetMLTransforms. */ getMLTransforms(input: AWS.Glue.GetMLTransformsRequest, options: SdkCallOptions): Promise; /** * Creates mappings. */ getMapping(input: AWS.Glue.GetMappingRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a specified partition. */ getPartition(input: AWS.Glue.GetPartitionRequest, options: SdkCallOptions): Promise; /** * Retrieves the partition indexes associated with a table. */ getPartitionIndexes(input: AWS.Glue.GetPartitionIndexesRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the partitions in a table. */ getPartitions(input: AWS.Glue.GetPartitionsRequest, options: SdkCallOptions): Promise; /** * Gets code to perform a specified mapping. */ getPlan(input: AWS.Glue.GetPlanRequest, options: SdkCallOptions): Promise; /** * Describes the specified registry in detail. */ getRegistry(input: AWS.Glue.GetRegistryInput, options: SdkCallOptions): Promise; /** * Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy. If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can't return the Data Catalog resource policy. */ getResourcePolicies(input: AWS.Glue.GetResourcePoliciesRequest, options: SdkCallOptions): Promise; /** * Retrieves a specified resource policy. */ getResourcePolicy(input: AWS.Glue.GetResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Describes the specified schema in detail. */ getSchema(input: AWS.Glue.GetSchemaInput, options: SdkCallOptions): Promise; /** * Retrieves a schema by the SchemaDefinition. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted statuses will not be included in the results. */ getSchemaByDefinition(input: AWS.Glue.GetSchemaByDefinitionInput, options: SdkCallOptions): Promise; /** * Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results. */ getSchemaVersion(input: AWS.Glue.GetSchemaVersionInput, options: SdkCallOptions): Promise; /** * Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry. This API allows you to compare two schema versions between two schema definitions under the same schema. */ getSchemaVersionsDiff(input: AWS.Glue.GetSchemaVersionsDiffInput, options: SdkCallOptions): Promise; /** * Retrieves a specified security configuration. */ getSecurityConfiguration(input: AWS.Glue.GetSecurityConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all security configurations. */ getSecurityConfigurations(input: AWS.Glue.GetSecurityConfigurationsRequest, options: SdkCallOptions): Promise; /** * Retrieves the session. */ getSession(input: AWS.Glue.GetSessionRequest, options: SdkCallOptions): Promise; /** * Retrieves the statement. */ getStatement(input: AWS.Glue.GetStatementRequest, options: SdkCallOptions): Promise; /** * Retrieves the Table definition in a Data Catalog for a specified table. */ getTable(input: AWS.Glue.GetTableRequest, options: SdkCallOptions): Promise; /** * Retrieves a specified version of a table. */ getTableVersion(input: AWS.Glue.GetTableVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of strings that identify available versions of a specified table. */ getTableVersions(input: AWS.Glue.GetTableVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves the definitions of some or all of the tables in a given Database. */ getTables(input: AWS.Glue.GetTablesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of tags associated with a resource. */ getTags(input: AWS.Glue.GetTagsRequest, options: SdkCallOptions): Promise; /** * Retrieves the definition of a trigger. */ getTrigger(input: AWS.Glue.GetTriggerRequest, options: SdkCallOptions): Promise; /** * Gets all the triggers associated with a job. */ getTriggers(input: AWS.Glue.GetTriggersRequest, options: SdkCallOptions): Promise; getUnfilteredPartitionMetadata(input: AWS.Glue.GetUnfilteredPartitionMetadataRequest, options: SdkCallOptions): Promise; getUnfilteredPartitionsMetadata(input: AWS.Glue.GetUnfilteredPartitionsMetadataRequest, options: SdkCallOptions): Promise; getUnfilteredTableMetadata(input: AWS.Glue.GetUnfilteredTableMetadataRequest, options: SdkCallOptions): Promise; /** * Retrieves a specified function definition from the Data Catalog. */ getUserDefinedFunction(input: AWS.Glue.GetUserDefinedFunctionRequest, options: SdkCallOptions): Promise; /** * Retrieves multiple function definitions from the Data Catalog. */ getUserDefinedFunctions(input: AWS.Glue.GetUserDefinedFunctionsRequest, options: SdkCallOptions): Promise; /** * Retrieves resource metadata for a workflow. */ getWorkflow(input: AWS.Glue.GetWorkflowRequest, options: SdkCallOptions): Promise; /** * Retrieves the metadata for a given workflow run. */ getWorkflowRun(input: AWS.Glue.GetWorkflowRunRequest, options: SdkCallOptions): Promise; /** * Retrieves the workflow run properties which were set during the run. */ getWorkflowRunProperties(input: AWS.Glue.GetWorkflowRunPropertiesRequest, options: SdkCallOptions): Promise; /** * Retrieves metadata for all runs of a given workflow. */ getWorkflowRuns(input: AWS.Glue.GetWorkflowRunsRequest, options: SdkCallOptions): Promise; /** * Imports an existing Amazon Athena Data Catalog to Glue. */ importCatalogToGlue(input: AWS.Glue.ImportCatalogToGlueRequest, options: SdkCallOptions): Promise; /** * Lists all the blueprint names in an account. */ listBlueprints(input: AWS.Glue.ListBlueprintsRequest, options: SdkCallOptions): Promise; /** * Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved. */ listCrawlers(input: AWS.Glue.ListCrawlersRequest, options: SdkCallOptions): Promise; /** * Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned. You may use this API to: Retrive all the crawls of a specified crawler. Retrieve all the crawls of a specified crawler within a limited count. Retrieve all the crawls of a specified crawler in a specific time range. Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value. */ listCrawls(input: AWS.Glue.ListCrawlsRequest, options: SdkCallOptions): Promise; /** * Lists all the custom patterns that have been created. */ listCustomEntityTypes(input: AWS.Glue.ListCustomEntityTypesRequest, options: SdkCallOptions): Promise; /** * Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved. */ listDevEndpoints(input: AWS.Glue.ListDevEndpointsRequest, options: SdkCallOptions): Promise; /** * Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved. */ listJobs(input: AWS.Glue.ListJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved. */ listMLTransforms(input: AWS.Glue.ListMLTransformsRequest, options: SdkCallOptions): Promise; /** * Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available. */ listRegistries(input: AWS.Glue.ListRegistriesInput, options: SdkCallOptions): Promise; /** * Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available. */ listSchemaVersions(input: AWS.Glue.ListSchemaVersionsInput, options: SdkCallOptions): Promise; /** * Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available. When the RegistryId is not provided, all the schemas across registries will be part of the API response. */ listSchemas(input: AWS.Glue.ListSchemasInput, options: SdkCallOptions): Promise; /** * Retrieve a list of sessions. */ listSessions(input: AWS.Glue.ListSessionsRequest, options: SdkCallOptions): Promise; /** * Lists statements for the session. */ listStatements(input: AWS.Glue.ListStatementsRequest, options: SdkCallOptions): Promise; /** * Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved. */ listTriggers(input: AWS.Glue.ListTriggersRequest, options: SdkCallOptions): Promise; /** * Lists names of workflows created in the account. */ listWorkflows(input: AWS.Glue.ListWorkflowsRequest, options: SdkCallOptions): Promise; /** * Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter. */ putDataCatalogEncryptionSettings(input: AWS.Glue.PutDataCatalogEncryptionSettingsRequest, options: SdkCallOptions): Promise; /** * Sets the Data Catalog resource policy for access control. */ putResourcePolicy(input: AWS.Glue.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls. */ putSchemaVersionMetadata(input: AWS.Glue.PutSchemaVersionMetadataInput, options: SdkCallOptions): Promise; /** * Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties. */ putWorkflowRunProperties(input: AWS.Glue.PutWorkflowRunPropertiesRequest, options: SdkCallOptions): Promise; /** * Queries for the schema version metadata information. */ querySchemaVersionMetadata(input: AWS.Glue.QuerySchemaVersionMetadataInput, options: SdkCallOptions): Promise; /** * Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry. If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes. If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller. */ registerSchemaVersion(input: AWS.Glue.RegisterSchemaVersionInput, options: SdkCallOptions): Promise; /** * Removes a key value pair from the schema version metadata for the specified schema version ID. */ removeSchemaVersionMetadata(input: AWS.Glue.RemoveSchemaVersionMetadataInput, options: SdkCallOptions): Promise; /** * Resets a bookmark entry. */ resetJobBookmark(input: AWS.Glue.ResetJobBookmarkRequest, options: SdkCallOptions): Promise; /** * Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run. */ resumeWorkflowRun(input: AWS.Glue.ResumeWorkflowRunRequest, options: SdkCallOptions): Promise; /** * Executes the statement. */ runStatement(input: AWS.Glue.RunStatementRequest, options: SdkCallOptions): Promise; /** * Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions. You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search. */ searchTables(input: AWS.Glue.SearchTablesRequest, options: SdkCallOptions): Promise; /** * Starts a new run of the specified blueprint. */ startBlueprintRun(input: AWS.Glue.StartBlueprintRunRequest, options: SdkCallOptions): Promise; /** * Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException. */ startCrawler(input: AWS.Glue.StartCrawlerRequest, options: SdkCallOptions): Promise; /** * Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED. */ startCrawlerSchedule(input: AWS.Glue.StartCrawlerScheduleRequest, options: SdkCallOptions): Promise; /** * Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use StartExportLabelsTaskRun when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the TransformId whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId. You can check on the status of your task run by calling the GetMLTaskRun API. */ startExportLabelsTaskRun(input: AWS.Glue.StartExportLabelsTaskRunRequest, options: SdkCallOptions): Promise; /** * Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning transform. After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called 'labeling' in the machine learning workflows). In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation. By default, StartMLLabelingSetGenerationTaskRun continually learns from and combines all labels that you upload unless you set Replace to true. If you set Replace to true, StartImportLabelsTaskRun deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality. You can check on the status of your task run by calling the GetMLTaskRun operation. */ startImportLabelsTaskRun(input: AWS.Glue.StartImportLabelsTaskRunRequest, options: SdkCallOptions): Promise; /** * Starts a job run using a job definition. */ startJobRun(input: AWS.Glue.StartJobRunRequest, options: SdkCallOptions): Promise; /** * Starts a task to estimate the quality of the transform. When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality. Returns a unique identifier for the run. You can call GetMLTaskRun to get more information about the stats of the EvaluationTaskRun. */ startMLEvaluationTaskRun(input: AWS.Glue.StartMLEvaluationTaskRunRequest, options: SdkCallOptions): Promise; /** * Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels. When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer. In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation. */ startMLLabelingSetGenerationTaskRun(input: AWS.Glue.StartMLLabelingSetGenerationTaskRunRequest, options: SdkCallOptions): Promise; /** * Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started. */ startTrigger(input: AWS.Glue.StartTriggerRequest, options: SdkCallOptions): Promise; /** * Starts a new run of the specified workflow. */ startWorkflowRun(input: AWS.Glue.StartWorkflowRunRequest, options: SdkCallOptions): Promise; /** * If the specified crawler is running, stops the crawl. */ stopCrawler(input: AWS.Glue.StopCrawlerRequest, options: SdkCallOptions): Promise; /** * Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running. */ stopCrawlerSchedule(input: AWS.Glue.StopCrawlerScheduleRequest, options: SdkCallOptions): Promise; /** * Stops the session. */ stopSession(input: AWS.Glue.StopSessionRequest, options: SdkCallOptions): Promise; /** * Stops a specified trigger. */ stopTrigger(input: AWS.Glue.StopTriggerRequest, options: SdkCallOptions): Promise; /** * Stops the execution of the specified workflow run. */ stopWorkflowRun(input: AWS.Glue.StopWorkflowRunRequest, options: SdkCallOptions): Promise; /** * Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you can tag, see Amazon Web Services Tags in Glue. */ tagResource(input: AWS.Glue.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource. */ untagResource(input: AWS.Glue.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a registered blueprint. */ updateBlueprint(input: AWS.Glue.UpdateBlueprintRequest, options: SdkCallOptions): Promise; /** * Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present). */ updateClassifier(input: AWS.Glue.UpdateClassifierRequest, options: SdkCallOptions): Promise; /** * Creates or updates partition statistics of columns. The Identity and Access Management (IAM) permission required for this operation is UpdatePartition. */ updateColumnStatisticsForPartition(input: AWS.Glue.UpdateColumnStatisticsForPartitionRequest, options: SdkCallOptions): Promise; /** * Creates or updates table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is UpdateTable. */ updateColumnStatisticsForTable(input: AWS.Glue.UpdateColumnStatisticsForTableRequest, options: SdkCallOptions): Promise; /** * Updates a connection definition in the Data Catalog. */ updateConnection(input: AWS.Glue.UpdateConnectionRequest, options: SdkCallOptions): Promise; /** * Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it. */ updateCrawler(input: AWS.Glue.UpdateCrawlerRequest, options: SdkCallOptions): Promise; /** * Updates the schedule of a crawler using a cron expression. */ updateCrawlerSchedule(input: AWS.Glue.UpdateCrawlerScheduleRequest, options: SdkCallOptions): Promise; /** * Updates an existing database definition in a Data Catalog. */ updateDatabase(input: AWS.Glue.UpdateDatabaseRequest, options: SdkCallOptions): Promise; /** * Updates a specified development endpoint. */ updateDevEndpoint(input: AWS.Glue.UpdateDevEndpointRequest, options: SdkCallOptions): Promise; /** * Updates an existing job definition. The previous job definition is completely overwritten by this information. */ updateJob(input: AWS.Glue.UpdateJobRequest, options: SdkCallOptions): Promise; /** * Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts. This API supports optional parameters which take in the repository information. */ updateJobFromSourceControl(input: AWS.Glue.UpdateJobFromSourceControlRequest, options: SdkCallOptions): Promise; /** * Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results. After calling this operation, you can call the StartMLEvaluationTaskRun operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective). */ updateMLTransform(input: AWS.Glue.UpdateMLTransformRequest, options: SdkCallOptions): Promise; /** * Updates a partition. */ updatePartition(input: AWS.Glue.UpdatePartitionRequest, options: SdkCallOptions): Promise; /** * Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry. */ updateRegistry(input: AWS.Glue.UpdateRegistryInput, options: SdkCallOptions): Promise; /** * Updates the description, compatibility setting, or version checkpoint for a schema set. For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency. If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema. This update will happen only if the schema is in the AVAILABLE state. */ updateSchema(input: AWS.Glue.UpdateSchemaInput, options: SdkCallOptions): Promise; /** * Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job. This API supports optional parameters which take in the repository information. */ updateSourceControlFromJob(input: AWS.Glue.UpdateSourceControlFromJobRequest, options: SdkCallOptions): Promise; /** * Updates a metadata table in the Data Catalog. */ updateTable(input: AWS.Glue.UpdateTableRequest, options: SdkCallOptions): Promise; /** * Updates a trigger definition. */ updateTrigger(input: AWS.Glue.UpdateTriggerRequest, options: SdkCallOptions): Promise; /** * Updates an existing function definition in the Data Catalog. */ updateUserDefinedFunction(input: AWS.Glue.UpdateUserDefinedFunctionRequest, options: SdkCallOptions): Promise; /** * Updates an existing workflow. */ updateWorkflow(input: AWS.Glue.UpdateWorkflowRequest, options: SdkCallOptions): Promise; } export interface Grafana { /** * Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise. */ associateLicense(input: AWS.Grafana.AssociateLicenseRequest, options: SdkCallOptions): Promise; /** * Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server. Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace. */ createWorkspace(input: AWS.Grafana.CreateWorkspaceRequest, options: SdkCallOptions): Promise; /** * Creates an API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests. */ createWorkspaceApiKey(input: AWS.Grafana.CreateWorkspaceApiKeyRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Managed Grafana workspace. */ deleteWorkspace(input: AWS.Grafana.DeleteWorkspaceRequest, options: SdkCallOptions): Promise; /** * Deletes an API key for a workspace. */ deleteWorkspaceApiKey(input: AWS.Grafana.DeleteWorkspaceApiKeyRequest, options: SdkCallOptions): Promise; /** * Displays information about one Amazon Managed Grafana workspace. */ describeWorkspace(input: AWS.Grafana.DescribeWorkspaceRequest, options: SdkCallOptions): Promise; /** * Displays information about the authentication methods used in one Amazon Managed Grafana workspace. */ describeWorkspaceAuthentication(input: AWS.Grafana.DescribeWorkspaceAuthenticationRequest, options: SdkCallOptions): Promise; /** * Removes the Grafana Enterprise license from a workspace. */ disassociateLicense(input: AWS.Grafana.DisassociateLicenseRequest, options: SdkCallOptions): Promise; /** * Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId, the operation returns the roles of all users and groups. If you specify a userId or a groupId, only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId. */ listPermissions(input: AWS.Grafana.ListPermissionsRequest, options: SdkCallOptions): Promise; /** * The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn. Currently, the only resource that can be tagged is a workspace. */ listTagsForResource(input: AWS.Grafana.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace. */ listWorkspaces(input: AWS.Grafana.ListWorkspacesRequest, options: SdkCallOptions): Promise; /** * The TagResource operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. */ tagResource(input: AWS.Grafana.TagResourceRequest, options: SdkCallOptions): Promise; /** * The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource. */ untagResource(input: AWS.Grafana.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates which users in a workspace have the Grafana Admin or Editor roles. */ updatePermissions(input: AWS.Grafana.UpdatePermissionsRequest, options: SdkCallOptions): Promise; /** * Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed. To modify the user authentication methods that the workspace uses, such as SAML or Amazon Web Services SSO, use UpdateWorkspaceAuthentication. To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions. */ updateWorkspace(input: AWS.Grafana.UpdateWorkspaceRequest, options: SdkCallOptions): Promise; /** * Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace. */ updateWorkspaceAuthentication(input: AWS.Grafana.UpdateWorkspaceAuthenticationRequest, options: SdkCallOptions): Promise; } export interface Greengrass { /** * Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud. */ associateRoleToGroup(input: AWS.Greengrass.AssociateRoleToGroupRequest, options: SdkCallOptions): Promise; /** * Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''. */ associateServiceRoleToAccount(input: AWS.Greengrass.AssociateServiceRoleToAccountRequest, options: SdkCallOptions): Promise; /** * Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time. */ createConnectorDefinition(input: AWS.Greengrass.CreateConnectorDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a version of a connector definition which has already been defined. */ createConnectorDefinitionVersion(input: AWS.Greengrass.CreateConnectorDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core. */ createCoreDefinition(input: AWS.Greengrass.CreateCoreDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core. */ createCoreDefinitionVersion(input: AWS.Greengrass.CreateCoreDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters. */ createDeployment(input: AWS.Greengrass.CreateDeploymentRequest, options: SdkCallOptions): Promise; /** * Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time. */ createDeviceDefinition(input: AWS.Greengrass.CreateDeviceDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a version of a device definition that has already been defined. */ createDeviceDefinitionVersion(input: AWS.Greengrass.CreateDeviceDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ''CreateFunctionDefinitionVersion'' later. */ createFunctionDefinition(input: AWS.Greengrass.CreateFunctionDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a version of a Lambda function definition that has already been defined. */ createFunctionDefinitionVersion(input: AWS.Greengrass.CreateFunctionDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups. */ createGroup(input: AWS.Greengrass.CreateGroupRequest, options: SdkCallOptions): Promise; /** * Creates a CA for the group. If a CA already exists, it will rotate the existing CA. */ createGroupCertificateAuthority(input: AWS.Greengrass.CreateGroupCertificateAuthorityRequest, options: SdkCallOptions): Promise; /** * Creates a version of a group which has already been defined. */ createGroupVersion(input: AWS.Greengrass.CreateGroupVersionRequest, options: SdkCallOptions): Promise; /** * Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time. */ createLoggerDefinition(input: AWS.Greengrass.CreateLoggerDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a version of a logger definition that has already been defined. */ createLoggerDefinitionVersion(input: AWS.Greengrass.CreateLoggerDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later. */ createResourceDefinition(input: AWS.Greengrass.CreateResourceDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a version of a resource definition that has already been defined. */ createResourceDefinitionVersion(input: AWS.Greengrass.CreateResourceDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job. */ createSoftwareUpdateJob(input: AWS.Greengrass.CreateSoftwareUpdateJobRequest, options: SdkCallOptions): Promise; /** * Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time. */ createSubscriptionDefinition(input: AWS.Greengrass.CreateSubscriptionDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a version of a subscription definition which has already been defined. */ createSubscriptionDefinitionVersion(input: AWS.Greengrass.CreateSubscriptionDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Deletes a connector definition. */ deleteConnectorDefinition(input: AWS.Greengrass.DeleteConnectorDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a core definition. */ deleteCoreDefinition(input: AWS.Greengrass.DeleteCoreDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a device definition. */ deleteDeviceDefinition(input: AWS.Greengrass.DeleteDeviceDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a Lambda function definition. */ deleteFunctionDefinition(input: AWS.Greengrass.DeleteFunctionDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a group. */ deleteGroup(input: AWS.Greengrass.DeleteGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a logger definition. */ deleteLoggerDefinition(input: AWS.Greengrass.DeleteLoggerDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a resource definition. */ deleteResourceDefinition(input: AWS.Greengrass.DeleteResourceDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a subscription definition. */ deleteSubscriptionDefinition(input: AWS.Greengrass.DeleteSubscriptionDefinitionRequest, options: SdkCallOptions): Promise; /** * Disassociates the role from a group. */ disassociateRoleFromGroup(input: AWS.Greengrass.DisassociateRoleFromGroupRequest, options: SdkCallOptions): Promise; /** * Disassociates the service role from your account. Without a service role, deployments will not work. */ disassociateServiceRoleFromAccount(input: AWS.Greengrass.DisassociateServiceRoleFromAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves the role associated with a particular group. */ getAssociatedRole(input: AWS.Greengrass.GetAssociatedRoleRequest, options: SdkCallOptions): Promise; /** * Returns the status of a bulk deployment. */ getBulkDeploymentStatus(input: AWS.Greengrass.GetBulkDeploymentStatusRequest, options: SdkCallOptions): Promise; /** * Retrieves the connectivity information for a core. */ getConnectivityInfo(input: AWS.Greengrass.GetConnectivityInfoRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a connector definition. */ getConnectorDefinition(input: AWS.Greengrass.GetConnectorDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services. */ getConnectorDefinitionVersion(input: AWS.Greengrass.GetConnectorDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a core definition version. */ getCoreDefinition(input: AWS.Greengrass.GetCoreDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a core definition version. */ getCoreDefinitionVersion(input: AWS.Greengrass.GetCoreDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Returns the status of a deployment. */ getDeploymentStatus(input: AWS.Greengrass.GetDeploymentStatusRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a device definition. */ getDeviceDefinition(input: AWS.Greengrass.GetDeviceDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a device definition version. */ getDeviceDefinitionVersion(input: AWS.Greengrass.GetDeviceDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a Lambda function definition, including its creation time and latest version. */ getFunctionDefinition(input: AWS.Greengrass.GetFunctionDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations. */ getFunctionDefinitionVersion(input: AWS.Greengrass.GetFunctionDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a group. */ getGroup(input: AWS.Greengrass.GetGroupRequest, options: SdkCallOptions): Promise; /** * Retreives the CA associated with a group. Returns the public key of the CA. */ getGroupCertificateAuthority(input: AWS.Greengrass.GetGroupCertificateAuthorityRequest, options: SdkCallOptions): Promise; /** * Retrieves the current configuration for the CA used by the group. */ getGroupCertificateConfiguration(input: AWS.Greengrass.GetGroupCertificateConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a group version. */ getGroupVersion(input: AWS.Greengrass.GetGroupVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a logger definition. */ getLoggerDefinition(input: AWS.Greengrass.GetLoggerDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a logger definition version. */ getLoggerDefinitionVersion(input: AWS.Greengrass.GetLoggerDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a resource definition, including its creation time and latest version. */ getResourceDefinition(input: AWS.Greengrass.GetResourceDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a resource definition version, including which resources are included in the version. */ getResourceDefinitionVersion(input: AWS.Greengrass.GetResourceDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves the service role that is attached to your account. */ getServiceRoleForAccount(input: AWS.Greengrass.GetServiceRoleForAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a subscription definition. */ getSubscriptionDefinition(input: AWS.Greengrass.GetSubscriptionDefinitionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a subscription definition version. */ getSubscriptionDefinitionVersion(input: AWS.Greengrass.GetSubscriptionDefinitionVersionRequest, options: SdkCallOptions): Promise; /** * Get the runtime configuration of a thing. */ getThingRuntimeConfiguration(input: AWS.Greengrass.GetThingRuntimeConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status. */ listBulkDeploymentDetailedReports(input: AWS.Greengrass.ListBulkDeploymentDetailedReportsRequest, options: SdkCallOptions): Promise; /** * Returns a list of bulk deployments. */ listBulkDeployments(input: AWS.Greengrass.ListBulkDeploymentsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services. */ listConnectorDefinitionVersions(input: AWS.Greengrass.ListConnectorDefinitionVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of connector definitions. */ listConnectorDefinitions(input: AWS.Greengrass.ListConnectorDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a core definition. */ listCoreDefinitionVersions(input: AWS.Greengrass.ListCoreDefinitionVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of core definitions. */ listCoreDefinitions(input: AWS.Greengrass.ListCoreDefinitionsRequest, options: SdkCallOptions): Promise; /** * Returns a history of deployments for the group. */ listDeployments(input: AWS.Greengrass.ListDeploymentsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a device definition. */ listDeviceDefinitionVersions(input: AWS.Greengrass.ListDeviceDefinitionVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of device definitions. */ listDeviceDefinitions(input: AWS.Greengrass.ListDeviceDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a Lambda function definition. */ listFunctionDefinitionVersions(input: AWS.Greengrass.ListFunctionDefinitionVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of Lambda function definitions. */ listFunctionDefinitions(input: AWS.Greengrass.ListFunctionDefinitionsRequest, options: SdkCallOptions): Promise; /** * Retrieves the current CAs for a group. */ listGroupCertificateAuthorities(input: AWS.Greengrass.ListGroupCertificateAuthoritiesRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a group. */ listGroupVersions(input: AWS.Greengrass.ListGroupVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of groups. */ listGroups(input: AWS.Greengrass.ListGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a logger definition. */ listLoggerDefinitionVersions(input: AWS.Greengrass.ListLoggerDefinitionVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of logger definitions. */ listLoggerDefinitions(input: AWS.Greengrass.ListLoggerDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a resource definition. */ listResourceDefinitionVersions(input: AWS.Greengrass.ListResourceDefinitionVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of resource definitions. */ listResourceDefinitions(input: AWS.Greengrass.ListResourceDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a subscription definition. */ listSubscriptionDefinitionVersions(input: AWS.Greengrass.ListSubscriptionDefinitionVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of subscription definitions. */ listSubscriptionDefinitions(input: AWS.Greengrass.ListSubscriptionDefinitionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of resource tags for a resource arn. */ listTagsForResource(input: AWS.Greengrass.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Resets a group's deployments. */ resetDeployments(input: AWS.Greengrass.ResetDeploymentsRequest, options: SdkCallOptions): Promise; /** * Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters. */ startBulkDeployment(input: AWS.Greengrass.StartBulkDeploymentRequest, options: SdkCallOptions): Promise; /** * Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments. */ stopBulkDeployment(input: AWS.Greengrass.StopBulkDeploymentRequest, options: SdkCallOptions): Promise; /** * Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'. */ tagResource(input: AWS.Greengrass.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Remove resource tags from a Greengrass Resource. */ untagResource(input: AWS.Greengrass.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it. */ updateConnectivityInfo(input: AWS.Greengrass.UpdateConnectivityInfoRequest, options: SdkCallOptions): Promise; /** * Updates a connector definition. */ updateConnectorDefinition(input: AWS.Greengrass.UpdateConnectorDefinitionRequest, options: SdkCallOptions): Promise; /** * Updates a core definition. */ updateCoreDefinition(input: AWS.Greengrass.UpdateCoreDefinitionRequest, options: SdkCallOptions): Promise; /** * Updates a device definition. */ updateDeviceDefinition(input: AWS.Greengrass.UpdateDeviceDefinitionRequest, options: SdkCallOptions): Promise; /** * Updates a Lambda function definition. */ updateFunctionDefinition(input: AWS.Greengrass.UpdateFunctionDefinitionRequest, options: SdkCallOptions): Promise; /** * Updates a group. */ updateGroup(input: AWS.Greengrass.UpdateGroupRequest, options: SdkCallOptions): Promise; /** * Updates the Certificate expiry time for a group. */ updateGroupCertificateConfiguration(input: AWS.Greengrass.UpdateGroupCertificateConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates a logger definition. */ updateLoggerDefinition(input: AWS.Greengrass.UpdateLoggerDefinitionRequest, options: SdkCallOptions): Promise; /** * Updates a resource definition. */ updateResourceDefinition(input: AWS.Greengrass.UpdateResourceDefinitionRequest, options: SdkCallOptions): Promise; /** * Updates a subscription definition. */ updateSubscriptionDefinition(input: AWS.Greengrass.UpdateSubscriptionDefinitionRequest, options: SdkCallOptions): Promise; /** * Updates the runtime configuration of a thing. */ updateThingRuntimeConfiguration(input: AWS.Greengrass.UpdateThingRuntimeConfigurationRequest, options: SdkCallOptions): Promise; } export interface GreengrassV2 { /** * Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide. */ associateServiceRoleToAccount(input: AWS.GreengrassV2.AssociateServiceRoleToAccountRequest, options: SdkCallOptions): Promise; /** * Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide. Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide. */ batchAssociateClientDeviceWithCoreDevice(input: AWS.GreengrassV2.BatchAssociateClientDeviceWithCoreDeviceRequest, options: SdkCallOptions): Promise; /** * Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates. */ batchDisassociateClientDeviceFromCoreDevice(input: AWS.GreengrassV2.BatchDisassociateClientDeviceFromCoreDeviceRequest, options: SdkCallOptions): Promise; /** * Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device. */ cancelDeployment(input: AWS.GreengrassV2.CancelDeploymentRequest, options: SdkCallOptions): Promise; /** * Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices. You can use this operation to do the following: Create components from recipes Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, specify inlineRecipe when you call this operation. Create components from Lambda functions Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function only accepts Lambda functions that use the following runtimes: Python 2.7 – python2.7 Python 3.7 – python3.7 Python 3.8 – python3.8 Python 3.9 – python3.9 Java 8 – java8 Java 11 – java11 Node.js 10 – nodejs10.x Node.js 12 – nodejs12.x Node.js 14 – nodejs14.x To create a component from a Lambda function, specify lambdaFunction when you call this operation. IoT Greengrass currently supports Lambda functions on only Linux core devices. */ createComponentVersion(input: AWS.GreengrassV2.CreateComponentVersionRequest, options: SdkCallOptions): Promise; /** * Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device. You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices. Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide. */ createDeployment(input: AWS.GreengrassV2.CreateDeploymentRequest, options: SdkCallOptions): Promise; /** * Deletes a version of a component from IoT Greengrass. This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version. */ deleteComponent(input: AWS.GreengrassV2.DeleteComponentRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference. */ deleteCoreDevice(input: AWS.GreengrassV2.DeleteCoreDeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment. Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted. */ deleteDeployment(input: AWS.GreengrassV2.DeleteDeploymentRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves metadata for a version of a component. */ describeComponent(input: AWS.GreengrassV2.DescribeComponentRequest, options: SdkCallOptions): Promise; /** * Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide. */ disassociateServiceRoleFromAccount(input: AWS.GreengrassV2.DisassociateServiceRoleFromAccountRequest, options: SdkCallOptions): Promise; /** * Gets the recipe for a version of a component. */ getComponent(input: AWS.GreengrassV2.GetComponentRequest, options: SdkCallOptions): Promise; /** * Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install. */ getComponentVersionArtifact(input: AWS.GreengrassV2.GetComponentVersionArtifactRequest, options: SdkCallOptions): Promise; /** * Retrieves connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide. */ getConnectivityInfo(input: AWS.GreengrassV2.GetConnectivityInfoRequest, options: SdkCallOptions): Promise; /** * Retrieves metadata for a Greengrass core device. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times: When the IoT Greengrass Core software starts When the core device receives a deployment from the Amazon Web Services Cloud When the status of any component on the core device becomes BROKEN At a regular interval that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment */ getCoreDevice(input: AWS.GreengrassV2.GetCoreDeviceRequest, options: SdkCallOptions): Promise; /** * Gets a deployment. Deployments define the components that run on Greengrass core devices. */ getDeployment(input: AWS.GreengrassV2.GetDeploymentRequest, options: SdkCallOptions): Promise; /** * Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide. */ getServiceRoleForAccount(input: AWS.GreengrassV2.GetServiceRoleForAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of client devices that are associated with a core device. */ listClientDevicesAssociatedWithCoreDevice(input: AWS.GreengrassV2.ListClientDevicesAssociatedWithCoreDeviceRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of all versions for a component. Greater versions are listed first. */ listComponentVersions(input: AWS.GreengrassV2.ListComponentVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of component summaries. This list includes components that you have permission to view. */ listComponents(input: AWS.GreengrassV2.ListComponentsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of Greengrass core devices. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times: When the IoT Greengrass Core software starts When the core device receives a deployment from the Amazon Web Services Cloud When the status of any component on the core device becomes BROKEN At a regular interval that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment */ listCoreDevices(input: AWS.GreengrassV2.ListCoreDevicesRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of deployments. */ listDeployments(input: AWS.GreengrassV2.ListDeploymentsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices. */ listEffectiveDeployments(input: AWS.GreengrassV2.ListEffectiveDeploymentsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the topologyFilter parameter to ALL. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times: When the IoT Greengrass Core software starts When the core device receives a deployment from the Amazon Web Services Cloud When the status of any component on the core device becomes BROKEN At a regular interval that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment */ listInstalledComponents(input: AWS.GreengrassV2.ListInstalledComponentsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of tags for an IoT Greengrass resource. */ listTagsForResource(input: AWS.GreengrassV2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install. This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency. When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud. To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see IoT Greengrass endpoints and quotas. */ resolveComponentCandidates(input: AWS.GreengrassV2.ResolveComponentCandidatesRequest, options: SdkCallOptions): Promise; /** * Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value. */ tagResource(input: AWS.GreengrassV2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from an IoT Greengrass resource. */ untagResource(input: AWS.GreengrassV2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide. */ updateConnectivityInfo(input: AWS.GreengrassV2.UpdateConnectivityInfoRequest, options: SdkCallOptions): Promise; } export interface GroundStation { /** * Cancels a contact with a specified contact ID. */ cancelContact(input: AWS.GroundStation.CancelContactRequest, options: SdkCallOptions): Promise; /** * Creates a Config with the specified configData parameters. Only one type of configData can be specified. */ createConfig(input: AWS.GroundStation.CreateConfigRequest, options: SdkCallOptions): Promise; /** * Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects. The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact. When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group. */ createDataflowEndpointGroup(input: AWS.GroundStation.CreateDataflowEndpointGroupRequest, options: SdkCallOptions): Promise; /** * Creates a mission profile. dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN. */ createMissionProfile(input: AWS.GroundStation.CreateMissionProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a Config. */ deleteConfig(input: AWS.GroundStation.DeleteConfigRequest, options: SdkCallOptions): Promise; /** * Deletes a dataflow endpoint group. */ deleteDataflowEndpointGroup(input: AWS.GroundStation.DeleteDataflowEndpointGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a mission profile. */ deleteMissionProfile(input: AWS.GroundStation.DeleteMissionProfileRequest, options: SdkCallOptions): Promise; /** * Describes an existing contact. */ describeContact(input: AWS.GroundStation.DescribeContactRequest, options: SdkCallOptions): Promise; /** * Returns Config information. Only one Config response can be returned. */ getConfig(input: AWS.GroundStation.GetConfigRequest, options: SdkCallOptions): Promise; /** * Returns the dataflow endpoint group. */ getDataflowEndpointGroup(input: AWS.GroundStation.GetDataflowEndpointGroupRequest, options: SdkCallOptions): Promise; /** * Returns the number of minutes used by account. */ getMinuteUsage(input: AWS.GroundStation.GetMinuteUsageRequest, options: SdkCallOptions): Promise; /** * Returns a mission profile. */ getMissionProfile(input: AWS.GroundStation.GetMissionProfileRequest, options: SdkCallOptions): Promise; /** * Returns a satellite. */ getSatellite(input: AWS.GroundStation.GetSatelliteRequest, options: SdkCallOptions): Promise; /** * Returns a list of Config objects. */ listConfigs(input: AWS.GroundStation.ListConfigsRequest, options: SdkCallOptions): Promise; /** * Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn. */ listContacts(input: AWS.GroundStation.ListContactsRequest, options: SdkCallOptions): Promise; /** * Returns a list of DataflowEndpoint groups. */ listDataflowEndpointGroups(input: AWS.GroundStation.ListDataflowEndpointGroupsRequest, options: SdkCallOptions): Promise; /** * Returns a list of ground stations. */ listGroundStations(input: AWS.GroundStation.ListGroundStationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of mission profiles. */ listMissionProfiles(input: AWS.GroundStation.ListMissionProfilesRequest, options: SdkCallOptions): Promise; /** * Returns a list of satellites. */ listSatellites(input: AWS.GroundStation.ListSatellitesRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags for a specified resource. */ listTagsForResource(input: AWS.GroundStation.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Reserves a contact using specified parameters. */ reserveContact(input: AWS.GroundStation.ReserveContactRequest, options: SdkCallOptions): Promise; /** * Assigns a tag to a resource. */ tagResource(input: AWS.GroundStation.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deassigns a resource tag. */ untagResource(input: AWS.GroundStation.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config. */ updateConfig(input: AWS.GroundStation.UpdateConfigRequest, options: SdkCallOptions): Promise; /** * Updates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts. */ updateMissionProfile(input: AWS.GroundStation.UpdateMissionProfileRequest, options: SdkCallOptions): Promise; } export interface GuardDuty { /** * Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation. */ acceptAdministratorInvitation(input: AWS.GuardDuty.AcceptAdministratorInvitationRequest, options: SdkCallOptions): Promise; /** * Accepts the invitation to be monitored by a GuardDuty administrator account. */ acceptInvitation(input: AWS.GuardDuty.AcceptInvitationRequest, options: SdkCallOptions): Promise; /** * Archives GuardDuty findings that are specified by the list of finding IDs. Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts. */ archiveFindings(input: AWS.GuardDuty.ArchiveFindingsRequest, options: SdkCallOptions): Promise; /** * Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region. All data sources are enabled in a new detector by default. */ createDetector(input: AWS.GuardDuty.CreateDetectorRequest, options: SdkCallOptions): Promise; /** * Creates a filter using the specified finding criteria. */ createFilter(input: AWS.GuardDuty.CreateFilterRequest, options: SdkCallOptions): Promise; /** * Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web Services infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation. */ createIPSet(input: AWS.GuardDuty.CreateIPSetRequest, options: SdkCallOptions): Promise; /** * Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization. When using Create Members as an organizations delegated administrator this action will enable GuardDuty in the added member accounts, with the exception of the organization delegated administrator account, which must enable GuardDuty prior to being added as a member. If you are adding accounts by invitation use this action after GuardDuty has been enabled in potential member accounts and before using Invite Members . */ createMembers(input: AWS.GuardDuty.CreateMembersRequest, options: SdkCallOptions): Promise; /** * Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation. */ createPublishingDestination(input: AWS.GuardDuty.CreatePublishingDestinationRequest, options: SdkCallOptions): Promise; /** * Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types. */ createSampleFindings(input: AWS.GuardDuty.CreateSampleFindingsRequest, options: SdkCallOptions): Promise; /** * Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator account can use this operation. */ createThreatIntelSet(input: AWS.GuardDuty.CreateThreatIntelSetRequest, options: SdkCallOptions): Promise; /** * Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs. */ declineInvitations(input: AWS.GuardDuty.DeclineInvitationsRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon GuardDuty detector that is specified by the detector ID. */ deleteDetector(input: AWS.GuardDuty.DeleteDetectorRequest, options: SdkCallOptions): Promise; /** * Deletes the filter specified by the filter name. */ deleteFilter(input: AWS.GuardDuty.DeleteFilterRequest, options: SdkCallOptions): Promise; /** * Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface. */ deleteIPSet(input: AWS.GuardDuty.DeleteIPSetRequest, options: SdkCallOptions): Promise; /** * Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs. */ deleteInvitations(input: AWS.GuardDuty.DeleteInvitationsRequest, options: SdkCallOptions): Promise; /** * Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs. */ deleteMembers(input: AWS.GuardDuty.DeleteMembersRequest, options: SdkCallOptions): Promise; /** * Deletes the publishing definition with the specified destinationId. */ deletePublishingDestination(input: AWS.GuardDuty.DeletePublishingDestinationRequest, options: SdkCallOptions): Promise; /** * Deletes the ThreatIntelSet specified by the ThreatIntelSet ID. */ deleteThreatIntelSet(input: AWS.GuardDuty.DeleteThreatIntelSetRequest, options: SdkCallOptions): Promise; /** * Returns a list of malware scans. */ describeMalwareScans(input: AWS.GuardDuty.DescribeMalwareScansRequest, options: SdkCallOptions): Promise; /** * Returns information about the account selected as the delegated administrator for GuardDuty. */ describeOrganizationConfiguration(input: AWS.GuardDuty.DescribeOrganizationConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns information about the publishing destination specified by the provided destinationId. */ describePublishingDestination(input: AWS.GuardDuty.DescribePublishingDestinationRequest, options: SdkCallOptions): Promise; /** * Disables an Amazon Web Services account within the Organization as the GuardDuty delegated administrator. */ disableOrganizationAdminAccount(input: AWS.GuardDuty.DisableOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates the current GuardDuty member account from its administrator account. */ disassociateFromAdministratorAccount(input: AWS.GuardDuty.DisassociateFromAdministratorAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates the current GuardDuty member account from its administrator account. */ disassociateFromMasterAccount(input: AWS.GuardDuty.DisassociateFromMasterAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs. */ disassociateMembers(input: AWS.GuardDuty.DisassociateMembersRequest, options: SdkCallOptions): Promise; /** * Enables an Amazon Web Services account within the organization as the GuardDuty delegated administrator. */ enableOrganizationAdminAccount(input: AWS.GuardDuty.EnableOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account. */ getAdministratorAccount(input: AWS.GuardDuty.GetAdministratorAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves an Amazon GuardDuty detector specified by the detectorId. */ getDetector(input: AWS.GuardDuty.GetDetectorRequest, options: SdkCallOptions): Promise; /** * Returns the details of the filter specified by the filter name. */ getFilter(input: AWS.GuardDuty.GetFilterRequest, options: SdkCallOptions): Promise; /** * Describes Amazon GuardDuty findings specified by finding IDs. */ getFindings(input: AWS.GuardDuty.GetFindingsRequest, options: SdkCallOptions): Promise; /** * Lists Amazon GuardDuty findings statistics for the specified detector ID. */ getFindingsStatistics(input: AWS.GuardDuty.GetFindingsStatisticsRequest, options: SdkCallOptions): Promise; /** * Retrieves the IPSet specified by the ipSetId. */ getIPSet(input: AWS.GuardDuty.GetIPSetRequest, options: SdkCallOptions): Promise; /** * Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation. */ getInvitationsCount(input: AWS.GuardDuty.GetInvitationsCountRequest, options: SdkCallOptions): Promise; /** * Returns the details of the malware scan settings. */ getMalwareScanSettings(input: AWS.GuardDuty.GetMalwareScanSettingsRequest, options: SdkCallOptions): Promise; /** * Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account. */ getMasterAccount(input: AWS.GuardDuty.GetMasterAccountRequest, options: SdkCallOptions): Promise; /** * Describes which data sources are enabled for the member account's detector. */ getMemberDetectors(input: AWS.GuardDuty.GetMemberDetectorsRequest, options: SdkCallOptions): Promise; /** * Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs. */ getMembers(input: AWS.GuardDuty.GetMembersRequest, options: SdkCallOptions): Promise; /** * Provides the number of days left for each data source used in the free trial period. */ getRemainingFreeTrialDays(input: AWS.GuardDuty.GetRemainingFreeTrialDaysRequest, options: SdkCallOptions): Promise; /** * Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID. */ getThreatIntelSet(input: AWS.GuardDuty.GetThreatIntelSetRequest, options: SdkCallOptions): Promise; /** * Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources, the cost returned will include only the usage so far under 30 days. This may differ from the cost metrics in the console, which project usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated. */ getUsageStatistics(input: AWS.GuardDuty.GetUsageStatisticsRequest, options: SdkCallOptions): Promise; /** * Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account. */ inviteMembers(input: AWS.GuardDuty.InviteMembersRequest, options: SdkCallOptions): Promise; /** * Lists detectorIds of all the existing Amazon GuardDuty detector resources. */ listDetectors(input: AWS.GuardDuty.ListDetectorsRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of the current filters. */ listFilters(input: AWS.GuardDuty.ListFiltersRequest, options: SdkCallOptions): Promise; /** * Lists Amazon GuardDuty findings for the specified detector ID. */ listFindings(input: AWS.GuardDuty.ListFindingsRequest, options: SdkCallOptions): Promise; /** * Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated administrator account. */ listIPSets(input: AWS.GuardDuty.ListIPSetsRequest, options: SdkCallOptions): Promise; /** * Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account. */ listInvitations(input: AWS.GuardDuty.ListInvitationsRequest, options: SdkCallOptions): Promise; /** * Lists details about all member accounts for the current GuardDuty administrator account. */ listMembers(input: AWS.GuardDuty.ListMembersRequest, options: SdkCallOptions): Promise; /** * Lists the accounts configured as GuardDuty delegated administrators. */ listOrganizationAdminAccounts(input: AWS.GuardDuty.ListOrganizationAdminAccountsRequest, options: SdkCallOptions): Promise; /** * Returns a list of publishing destinations associated with the specified detectorId. */ listPublishingDestinations(input: AWS.GuardDuty.ListPublishingDestinationsRequest, options: SdkCallOptions): Promise; /** * Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource. */ listTagsForResource(input: AWS.GuardDuty.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated with the administrator account are returned. */ listThreatIntelSets(input: AWS.GuardDuty.ListThreatIntelSetsRequest, options: SdkCallOptions): Promise; /** * Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation. */ startMonitoringMembers(input: AWS.GuardDuty.StartMonitoringMembersRequest, options: SdkCallOptions): Promise; /** * Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts. */ stopMonitoringMembers(input: AWS.GuardDuty.StopMonitoringMembersRequest, options: SdkCallOptions): Promise; /** * Adds tags to a resource. */ tagResource(input: AWS.GuardDuty.TagResourceRequest, options: SdkCallOptions): Promise; /** * Unarchives GuardDuty findings specified by the findingIds. */ unarchiveFindings(input: AWS.GuardDuty.UnarchiveFindingsRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource. */ untagResource(input: AWS.GuardDuty.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the Amazon GuardDuty detector specified by the detectorId. */ updateDetector(input: AWS.GuardDuty.UpdateDetectorRequest, options: SdkCallOptions): Promise; /** * Updates the filter specified by the filter name. */ updateFilter(input: AWS.GuardDuty.UpdateFilterRequest, options: SdkCallOptions): Promise; /** * Marks the specified GuardDuty findings as useful or not useful. */ updateFindingsFeedback(input: AWS.GuardDuty.UpdateFindingsFeedbackRequest, options: SdkCallOptions): Promise; /** * Updates the IPSet specified by the IPSet ID. */ updateIPSet(input: AWS.GuardDuty.UpdateIPSetRequest, options: SdkCallOptions): Promise; /** * Updates the malware scan settings. */ updateMalwareScanSettings(input: AWS.GuardDuty.UpdateMalwareScanSettingsRequest, options: SdkCallOptions): Promise; /** * Contains information on member accounts to be updated. */ updateMemberDetectors(input: AWS.GuardDuty.UpdateMemberDetectorsRequest, options: SdkCallOptions): Promise; /** * Updates the delegated administrator account with the values provided. */ updateOrganizationConfiguration(input: AWS.GuardDuty.UpdateOrganizationConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates information about the publishing destination specified by the destinationId. */ updatePublishingDestination(input: AWS.GuardDuty.UpdatePublishingDestinationRequest, options: SdkCallOptions): Promise; /** * Updates the ThreatIntelSet specified by the ThreatIntelSet ID. */ updateThreatIntelSet(input: AWS.GuardDuty.UpdateThreatIntelSetRequest, options: SdkCallOptions): Promise; } export interface Health { /** * Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. */ describeAffectedAccountsForOrganization(input: AWS.Health.DescribeAffectedAccountsForOrganizationRequest, options: SdkCallOptions): Promise; /** * Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide. */ describeAffectedEntities(input: AWS.Health.DescribeAffectedEntitiesRequest, options: SdkCallOptions): Promise; /** * Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. At least one event Amazon Resource Name (ARN) and account ID are required. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide. */ describeAffectedEntitiesForOrganization(input: AWS.Health.DescribeAffectedEntitiesForOrganizationRequest, options: SdkCallOptions): Promise; /** * Returns the number of entities that are affected by each of the specified events. */ describeEntityAggregates(input: AWS.Health.DescribeEntityAggregatesRequest, options: SdkCallOptions): Promise; /** * Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. */ describeEventAggregates(input: AWS.Health.DescribeEventAggregatesRequest, options: SdkCallOptions): Promise; /** * Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation. If a specified event can't be retrieved, an error message is returned for that event. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide. */ describeEventDetails(input: AWS.Health.DescribeEventDetailsRequest, options: SdkCallOptions): Promise; /** * Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences: To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account. To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization. For more information, see Event. This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide. */ describeEventDetailsForOrganization(input: AWS.Health.DescribeEventDetailsForOrganizationRequest, options: SdkCallOptions): Promise; /** * Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Services service, and event code. The metadata for each event appears in the EventType object. If you don't specify a filter criteria, the API operation returns all event types, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. */ describeEventTypes(input: AWS.Health.DescribeEventTypesRequest, options: SdkCallOptions): Promise; /** * Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. */ describeEvents(input: AWS.Health.DescribeEventsRequest, options: SdkCallOptions): Promise; /** * Returns information about events across your organization in Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations: DescribeAffectedAccountsForOrganization DescribeEventDetailsForOrganization DescribeAffectedEntitiesForOrganization If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event. For more information about the different types of Health events, see Event. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. */ describeEventsForOrganization(input: AWS.Health.DescribeEventsForOrganizationRequest, options: SdkCallOptions): Promise; } export interface HealthLake { /** * Creates a Data Store that can ingest and export FHIR formatted data. */ createFHIRDatastore(input: AWS.HealthLake.CreateFHIRDatastoreRequest, options: SdkCallOptions): Promise; /** * Deletes a Data Store. */ deleteFHIRDatastore(input: AWS.HealthLake.DeleteFHIRDatastoreRequest, options: SdkCallOptions): Promise; /** * Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint. */ describeFHIRDatastore(input: AWS.HealthLake.DescribeFHIRDatastoreRequest, options: SdkCallOptions): Promise; /** * Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job. */ describeFHIRExportJob(input: AWS.HealthLake.DescribeFHIRExportJobRequest, options: SdkCallOptions): Promise; /** * Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job. */ describeFHIRImportJob(input: AWS.HealthLake.DescribeFHIRImportJobRequest, options: SdkCallOptions): Promise; /** * Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status. */ listFHIRDatastores(input: AWS.HealthLake.ListFHIRDatastoresRequest, options: SdkCallOptions): Promise; /** * Lists all FHIR export jobs associated with an account and their statuses. */ listFHIRExportJobs(input: AWS.HealthLake.ListFHIRExportJobsRequest, options: SdkCallOptions): Promise; /** * Lists all FHIR import jobs associated with an account and their statuses. */ listFHIRImportJobs(input: AWS.HealthLake.ListFHIRImportJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all existing tags associated with a Data Store. */ listTagsForResource(input: AWS.HealthLake.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Begins a FHIR export job. */ startFHIRExportJob(input: AWS.HealthLake.StartFHIRExportJobRequest, options: SdkCallOptions): Promise; /** * Begins a FHIR Import job. */ startFHIRImportJob(input: AWS.HealthLake.StartFHIRImportJobRequest, options: SdkCallOptions): Promise; /** * Adds a user specifed key and value tag to a Data Store. */ tagResource(input: AWS.HealthLake.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a Data Store. */ untagResource(input: AWS.HealthLake.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface Honeycode { /** * The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook. The API allows you to specify the values to set in some or all of the columns in the new rows. If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows. */ batchCreateTableRows(input: AWS.Honeycode.BatchCreateTableRowsRequest, options: SdkCallOptions): Promise; /** * The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. You need to specify the ids of the rows that you want to delete from the table. */ batchDeleteTableRows(input: AWS.Honeycode.BatchDeleteTableRowsRequest, options: SdkCallOptions): Promise; /** * The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook. You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string (""). */ batchUpdateTableRows(input: AWS.Honeycode.BatchUpdateTableRowsRequest, options: SdkCallOptions): Promise; /** * The BatchUpsertTableRows API allows you to upsert one or more rows in a table. The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request. You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string (""). */ batchUpsertTableRows(input: AWS.Honeycode.BatchUpsertTableRowsRequest, options: SdkCallOptions): Promise; /** * The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job. */ describeTableDataImportJob(input: AWS.Honeycode.DescribeTableDataImportJobRequest, options: SdkCallOptions): Promise; /** * The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen. */ getScreenData(input: AWS.Honeycode.GetScreenDataRequest, options: SdkCallOptions): Promise; /** * The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook. */ invokeScreenAutomation(input: AWS.Honeycode.InvokeScreenAutomationRequest, options: SdkCallOptions): Promise; /** * The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook. */ listTableColumns(input: AWS.Honeycode.ListTableColumnsRequest, options: SdkCallOptions): Promise; /** * The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook. */ listTableRows(input: AWS.Honeycode.ListTableRowsRequest, options: SdkCallOptions): Promise; /** * The ListTables API allows you to retrieve a list of all the tables in a workbook. */ listTables(input: AWS.Honeycode.ListTablesRequest, options: SdkCallOptions): Promise; /** * The ListTagsForResource API allows you to return a resource's tags. */ listTagsForResource(input: AWS.Honeycode.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * The QueryTableRows API allows you to use a filter formula to query for specific rows in a table. */ queryTableRows(input: AWS.Honeycode.QueryTableRowsRequest, options: SdkCallOptions): Promise; /** * The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API. */ startTableDataImportJob(input: AWS.Honeycode.StartTableDataImportJobRequest, options: SdkCallOptions): Promise; /** * The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation. */ tagResource(input: AWS.Honeycode.TagResourceRequest, options: SdkCallOptions): Promise; /** * The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation. */ untagResource(input: AWS.Honeycode.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface IAM { /** * Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource. This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider. */ addClientIDToOpenIDConnectProvider(input: AWS.IAM.AddClientIDToOpenIDConnectProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it. The caller of this operation must be granted the PassRole permission on the IAM role by a permissions policy. For more information about roles, see Working with roles. For more information about instance profiles, see About instance profiles. */ addRoleToInstanceProfile(input: AWS.IAM.AddRoleToInstanceProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Adds the specified user to the specified group. */ addUserToGroup(input: AWS.IAM.AddUserToGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Attaches the specified managed policy to the specified IAM group. You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy. As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide. For more information about policies, see Managed policies and inline policies in the IAM User Guide. */ attachGroupPolicy(input: AWS.IAM.AttachGroupPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed policies and inline policies in the IAM User Guide. As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide. */ attachRolePolicy(input: AWS.IAM.AttachRolePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Attaches the specified managed policy to the specified user. You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy. As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide. For more information about policies, see Managed policies and inline policies in the IAM User Guide. */ attachUserPolicy(input: AWS.IAM.AttachUserPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation. Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwords in the IAM User Guide. */ changePassword(input: AWS.IAM.ChangePasswordRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is Active. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users. For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide. To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. */ createAccessKey(input: AWS.IAM.CreateAccessKeyRequest, options: SdkCallOptions): Promise; /** * Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide. */ createAccountAlias(input: AWS.IAM.CreateAccountAliasRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a new group. For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide. */ createGroup(input: AWS.IAM.CreateGroupRequest, options: SdkCallOptions): Promise; /** * Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide. For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide. */ createInstanceProfile(input: AWS.IAM.CreateInstanceProfileRequest, options: SdkCallOptions): Promise; /** * Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console. For more information about managing passwords, see Managing passwords in the IAM User Guide. */ createLoginProfile(input: AWS.IAM.CreateLoginProfileRequest, options: SdkCallOptions): Promise; /** * Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC). The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider. If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide. When you create the IAM OIDC provider, you specify the following: The URL of the OIDC identity provider (IdP) to trust A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider A list of thumbprints of one or more server certificates that the IdP uses You get all of this information from the OIDC IdP you want to use to access Amazon Web Services. Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation. The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users. */ createOpenIDConnectProvider(input: AWS.IAM.CreateOpenIDConnectProviderRequest, options: SdkCallOptions): Promise; /** * Creates a new managed policy for your Amazon Web Services account. This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide. As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide. For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide. */ createPolicy(input: AWS.IAM.CreatePolicyRequest, options: SdkCallOptions): Promise; /** * Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version. Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached. For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide. */ createPolicyVersion(input: AWS.IAM.CreatePolicyVersionRequest, options: SdkCallOptions): Promise; /** * Creates a new role for your Amazon Web Services account. For more information about roles, see IAM roles. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide. */ createRole(input: AWS.IAM.CreateRoleRequest, options: SdkCallOptions): Promise; /** * Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0. The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services. When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP. This operation requires Signature Version 4. For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide. */ createSAMLProvider(input: AWS.IAM.CreateSAMLProviderRequest, options: SdkCallOptions): Promise; /** * Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using service-linked roles in the IAM User Guide. To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role. */ createServiceLinkedRole(input: AWS.IAM.CreateServiceLinkedRoleRequest, options: SdkCallOptions): Promise; /** * Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. You can have a maximum of two sets of service-specific credentials for each supported service per user. You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra). You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential. For more information about service-specific credentials, see Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide. */ createServiceSpecificCredential(input: AWS.IAM.CreateServiceSpecificCredentialRequest, options: SdkCallOptions): Promise; /** * Creates a new IAM user for your Amazon Web Services account. For information about quotas for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide. */ createUser(input: AWS.IAM.CreateUserRequest, options: SdkCallOptions): Promise; /** * Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide. For information about the maximum number of MFA devices you can create, see IAM and STS quotas in the IAM User Guide. The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures. */ createVirtualMFADevice(input: AWS.IAM.CreateVirtualMFADeviceRequest, options: SdkCallOptions): Promise; /** * Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled. For more information about creating and working with virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the IAM User Guide. */ deactivateMFADevice(input: AWS.IAM.DeactivateMFADeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the access key pair associated with the specified IAM user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users. */ deleteAccessKey(input: AWS.IAM.DeleteAccessKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide. */ deleteAccountAlias(input: AWS.IAM.DeleteAccountAliasRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified IAM group. The group must not contain any users or have any attached policies. */ deleteGroup(input: AWS.IAM.DeleteGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified inline policy that is embedded in the specified IAM group. A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide. */ deleteGroupPolicy(input: AWS.IAM.DeleteGroupPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified instance profile. The instance profile must not have an associated role. Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. For more information about instance profiles, see About instance profiles. */ deleteInstanceProfile(input: AWS.IAM.DeleteInstanceProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the password for the specified IAM user, which terminates the user's ability to access Amazon Web Services services through the Amazon Web Services Management Console. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console. Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. */ deleteLoginProfile(input: AWS.IAM.DeleteLoginProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an OpenID Connect identity provider (IdP) resource object in IAM. Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails. This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist. */ deleteOpenIDConnectProvider(input: AWS.IAM.DeleteOpenIDConnectProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified managed policy. Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy: Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy. Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process. Delete the policy (this automatically deletes the policy's default version) using this operation. For information about managed policies, see Managed policies and inline policies in the IAM User Guide. */ deletePolicy(input: AWS.IAM.DeletePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified version from the specified managed policy. You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions. For information about versions for managed policies, see Versioning for managed policies in the IAM User Guide. */ deletePolicyVersion(input: AWS.IAM.DeletePolicyVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified role. The role must not have any policies attached. For more information about roles, see Working with roles. Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. */ deleteRole(input: AWS.IAM.DeleteRoleRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the permissions boundary for the specified IAM role. Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies. */ deleteRolePermissionsBoundary(input: AWS.IAM.DeleteRolePermissionsBoundaryRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified inline policy that is embedded in the specified IAM role. A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide. */ deleteRolePolicy(input: AWS.IAM.DeleteRolePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a SAML provider resource in IAM. Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails. This operation requires Signature Version 4. */ deleteSAMLProvider(input: AWS.IAM.DeleteSAMLProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified SSH public key. The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide. */ deleteSSHPublicKey(input: AWS.IAM.DeleteSSHPublicKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified server certificate. For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM. If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference. */ deleteServerCertificate(input: AWS.IAM.DeleteServerCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned. If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the Amazon Web Services documentation for your service. For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the IAM User Guide. */ deleteServiceLinkedRole(input: AWS.IAM.DeleteServiceLinkedRoleRequest, options: SdkCallOptions): Promise; /** * Deletes the specified service-specific credential. */ deleteServiceSpecificCredential(input: AWS.IAM.DeleteServiceSpecificCredentialRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a signing certificate associated with the specified IAM user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users. */ deleteSigningCertificate(input: AWS.IAM.DeleteSigningCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items: Password (DeleteLoginProfile) Access keys (DeleteAccessKey) Signing certificate (DeleteSigningCertificate) SSH public key (DeleteSSHPublicKey) Git credentials (DeleteServiceSpecificCredential) Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice) Inline policies (DeleteUserPolicy) Attached managed policies (DetachUserPolicy) Group memberships (RemoveUserFromGroup) */ deleteUser(input: AWS.IAM.DeleteUserRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the permissions boundary for the specified IAM user. Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies. */ deleteUserPermissionsBoundary(input: AWS.IAM.DeleteUserPermissionsBoundaryRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified inline policy that is embedded in the specified IAM user. A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide. */ deleteUserPolicy(input: AWS.IAM.DeleteUserPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a virtual MFA device. You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice. */ deleteVirtualMFADevice(input: AWS.IAM.DeleteVirtualMFADeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified managed policy from the specified IAM group. A group can also have inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide. */ detachGroupPolicy(input: AWS.IAM.DetachGroupPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified managed policy from the specified role. A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide. */ detachRolePolicy(input: AWS.IAM.DetachRolePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified managed policy from the specified user. A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide. */ detachUserPolicy(input: AWS.IAM.DetachUserPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device. */ enableMFADevice(input: AWS.IAM.EnableMFADeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization. To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed data in the IAM User Guide. You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity. You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP. For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed data in the IAM User Guide. The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide. This operation returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report. To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report. Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs. OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs. management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account. Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account. To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service. Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data. OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data. management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account. Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data. Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide. For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide. */ generateOrganizationsAccessReport(input: AWS.IAM.GenerateOrganizationsAccessReportRequest, options: SdkCallOptions): Promise; /** * Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked. The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide. The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report: GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail. GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service. To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter. For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation. Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide. For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide. */ generateServiceLastAccessedDetails(input: AWS.IAM.GenerateServiceLastAccessedDetailsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key. */ getAccessKeyLastUsed(input: AWS.IAM.GetAccessKeyLastUsedRequest, options: SdkCallOptions): Promise; /** * Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account. Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters. */ getAccountAuthorizationDetails(input: AWS.IAM.GetAccountAuthorizationDetailsRequest, options: SdkCallOptions): Promise; /** * Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request. */ getContextKeysForCustomPolicy(input: AWS.IAM.GetContextKeysForCustomPolicyRequest, options: SdkCallOptions): Promise; /** * Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. */ getContextKeysForPrincipalPolicy(input: AWS.IAM.GetContextKeysForPrincipalPolicyRequest, options: SdkCallOptions): Promise; /** * Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters. */ getGroup(input: AWS.IAM.GetGroupRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified inline policy document that is embedded in the specified IAM group. Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed policies and inline policies in the IAM User Guide. */ getGroupPolicy(input: AWS.IAM.GetGroupPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About instance profiles in the IAM User Guide. */ getInstanceProfile(input: AWS.IAM.GetInstanceProfileRequest, options: SdkCallOptions): Promise; /** * Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (NoSuchEntity) error. If you create an IAM user with access to the console, the CreateDate reflects the date you created the initial password for the user. If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console. */ getLoginProfile(input: AWS.IAM.GetLoginProfileRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM. */ getOpenIDConnectProvider(input: AWS.IAM.GetOpenIDConnectProviderRequest, options: SdkCallOptions): Promise; /** * Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents. Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport. To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide. For each service that principals in an account (root users, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed. By default, the list is sorted by service namespace. */ getOrganizationsAccessReport(input: AWS.IAM.GetOrganizationsAccessReportRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion. This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy. For more information about policies, see Managed policies and inline policies in the IAM User Guide. */ getPolicy(input: AWS.IAM.GetPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified version of the specified managed policy, including the policy document. Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. To list the available versions for a policy, use ListPolicyVersions. This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy. For more information about the types of policies, see Managed policies and inline policies in the IAM User Guide. For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide. */ getPolicyVersion(input: AWS.IAM.GetPolicyVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with roles. Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. */ getRole(input: AWS.IAM.GetRoleRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified inline policy document that is embedded with the specified IAM role. Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed policies and inline policies in the IAM User Guide. For more information about roles, see Using roles to delegate permissions and federate identities. */ getRolePolicy(input: AWS.IAM.GetRolePolicyRequest, options: SdkCallOptions): Promise; /** * Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated. This operation requires Signature Version 4. */ getSAMLProvider(input: AWS.IAM.GetSAMLProviderRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified SSH public key, including metadata about the key. The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide. */ getSSHPublicKey(input: AWS.IAM.GetSSHPublicKeyRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified server certificate stored in IAM. For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM. */ getServerCertificate(input: AWS.IAM.GetServerCertificateRequest, options: SdkCallOptions): Promise; /** * Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access. Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide. For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed. The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report: User – Returns the user ARN that you used to generate the report Group – Returns the ARN of the group member (user) that last attempted to access the service Role – Returns the role ARN that you used to generate the report Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service By default, the list is sorted by service namespace. If you specified ACTION_LEVEL granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data. For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide. */ getServiceLastAccessedDetails(input: AWS.IAM.GetServiceLastAccessedDetailsRequest, options: SdkCallOptions): Promise; /** * After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service. Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service. Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service. You can also use this operation for user or role reports to retrieve details about those entities. If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed. By default, the list of associated entities is sorted by date, with the most recent access listed first. */ getServiceLastAccessedDetailsWithEntities(input: AWS.IAM.GetServiceLastAccessedDetailsWithEntitiesRequest, options: SdkCallOptions): Promise; /** * Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service. */ getServiceLinkedRoleDeletionStatus(input: AWS.IAM.GetServiceLinkedRoleDeletionStatusRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation. */ getUser(input: AWS.IAM.GetUserRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified inline policy document that is embedded in the specified IAM user. Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality. An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document. For more information about policies, see Managed policies and inline policies in the IAM User Guide. */ getUserPolicy(input: AWS.IAM.GetUserPolicyRequest, options: SdkCallOptions): Promise; /** * Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list. Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters. If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users. To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. */ listAccessKeys(input: AWS.IAM.ListAccessKeysRequest, options: SdkCallOptions): Promise; /** * Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide. */ listAccountAliases(input: AWS.IAM.ListAccountAliasesRequest, options: SdkCallOptions): Promise; /** * Lists all managed policies that are attached to the specified IAM group. An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use ListGroupPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list. */ listAttachedGroupPolicies(input: AWS.IAM.ListAttachedGroupPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists all managed policies that are attached to the specified IAM role. An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use ListRolePolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list. */ listAttachedRolePolicies(input: AWS.IAM.ListAttachedRolePoliciesRequest, options: SdkCallOptions): Promise; /** * Lists all managed policies that are attached to the specified IAM user. An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use ListUserPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list. */ listAttachedUserPolicies(input: AWS.IAM.ListAttachedUserPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists all IAM users, groups, and roles that the specified managed policy is attached to. You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role. You can paginate the results using the MaxItems and Marker parameters. */ listEntitiesForPolicy(input: AWS.IAM.ListEntitiesForPolicyRequest, options: SdkCallOptions): Promise; /** * Lists the names of the inline policies that are embedded in the specified IAM group. An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list. */ listGroupPolicies(input: AWS.IAM.ListGroupPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the IAM groups that have the specified path prefix. You can paginate the results using the MaxItems and Marker parameters. */ listGroups(input: AWS.IAM.ListGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the IAM groups that the specified IAM user belongs to. You can paginate the results using the MaxItems and Marker parameters. */ listGroupsForUser(input: AWS.IAM.ListGroupsForUserRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ listInstanceProfileTags(input: AWS.IAM.ListInstanceProfileTagsRequest, options: SdkCallOptions): Promise; /** * Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see About instance profiles. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile. You can paginate the results using the MaxItems and Marker parameters. */ listInstanceProfiles(input: AWS.IAM.ListInstanceProfilesRequest, options: SdkCallOptions): Promise; /** * Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to About instance profiles. You can paginate the results using the MaxItems and Marker parameters. */ listInstanceProfilesForRole(input: AWS.IAM.ListInstanceProfilesForRoleRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ listMFADeviceTags(input: AWS.IAM.ListMFADeviceTagsRequest, options: SdkCallOptions): Promise; /** * Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation. You can paginate the results using the MaxItems and Marker parameters. */ listMFADevices(input: AWS.IAM.ListMFADevicesRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ listOpenIDConnectProviderTags(input: AWS.IAM.ListOpenIDConnectProviderTagsRequest, options: SdkCallOptions): Promise; /** * Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider. */ listOpenIDConnectProviders(input: AWS.IAM.ListOpenIDConnectProvidersRequest, options: SdkCallOptions): Promise; /** * Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies. You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to Local. To list only Amazon Web Services managed policies, set Scope to AWS. You can paginate the results using the MaxItems and Marker parameters. For more information about managed policies, see Managed policies and inline policies in the IAM User Guide. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy. */ listPolicies(input: AWS.IAM.ListPoliciesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service. This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide. The list of policies returned by the operation depends on the ARN of the identity that you provide. User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs. Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included. Role – The list of policies includes only the managed and inline policies that are attached to the role. For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide. Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations. */ listPoliciesGrantingServiceAccess(input: AWS.IAM.ListPoliciesGrantingServiceAccessRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ listPolicyTags(input: AWS.IAM.ListPolicyTagsRequest, options: SdkCallOptions): Promise; /** * Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version. For more information about managed policies, see Managed policies and inline policies in the IAM User Guide. */ listPolicyVersions(input: AWS.IAM.ListPolicyVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the names of the inline policies that are embedded in the specified IAM role. An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list. */ listRolePolicies(input: AWS.IAM.ListRolePoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ listRoleTags(input: AWS.IAM.ListRoleTagsRequest, options: SdkCallOptions): Promise; /** * Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see Working with roles. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see GetRole. You can paginate the results using the MaxItems and Marker parameters. */ listRoles(input: AWS.IAM.ListRolesRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ listSAMLProviderTags(input: AWS.IAM.ListSAMLProviderTagsRequest, options: SdkCallOptions): Promise; /** * Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider. This operation requires Signature Version 4. */ listSAMLProviders(input: AWS.IAM.ListSAMLProvidersRequest, options: SdkCallOptions): Promise; /** * Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list. The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide. Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters. */ listSSHPublicKeys(input: AWS.IAM.ListSSHPublicKeysRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide. */ listServerCertificateTags(input: AWS.IAM.ListServerCertificateTagsRequest, options: SdkCallOptions): Promise; /** * Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list. You can paginate the results using the MaxItems and Marker parameters. For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate. */ listServerCertificates(input: AWS.IAM.ListServerCertificatesRequest, options: SdkCallOptions): Promise; /** * Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials in the CodeCommit User Guide. */ listServiceSpecificCredentials(input: AWS.IAM.ListServiceSpecificCredentialsRequest, options: SdkCallOptions): Promise; /** * Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list. Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters. If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users. */ listSigningCertificates(input: AWS.IAM.ListSigningCertificatesRequest, options: SdkCallOptions): Promise; /** * Lists the names of the inline policies embedded in the specified IAM user. An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list. */ listUserPolicies(input: AWS.IAM.ListUserPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ listUserTags(input: AWS.IAM.ListUserTagsRequest, options: SdkCallOptions): Promise; /** * Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see GetUser. You can paginate the results using the MaxItems and Marker parameters. */ listUsers(input: AWS.IAM.ListUsersRequest, options: SdkCallOptions): Promise; /** * Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags. You can paginate the results using the MaxItems and Marker parameters. */ listVirtualMFADevices(input: AWS.IAM.ListVirtualMFADevicesRequest, options: SdkCallOptions): Promise; /** * Adds or updates an inline policy document that is embedded in the specified IAM group. A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide. For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide. */ putGroupPolicy(input: AWS.IAM.PutGroupPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role. You cannot set the boundary for a service-linked role. Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide. */ putRolePermissionsBoundary(input: AWS.IAM.PutRolePermissionsBoundaryRequest, options: SdkCallOptions): Promise<{}>; /** * Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, see Using roles to delegate permissions and federate identities. A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide. For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide. */ putRolePolicy(input: AWS.IAM.PutRolePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user. Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide. */ putUserPermissionsBoundary(input: AWS.IAM.PutUserPermissionsBoundaryRequest, options: SdkCallOptions): Promise<{}>; /** * Adds or updates an inline policy document that is embedded in the specified IAM user. An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide. For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide. */ putUserPolicy(input: AWS.IAM.PutUserPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object. This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist. */ removeClientIDFromOpenIDConnectProvider(input: AWS.IAM.RemoveClientIDFromOpenIDConnectProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified IAM role from the specified EC2 instance profile. Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance. For more information about IAM roles, see Working with roles. For more information about instance profiles, see About instance profiles. */ removeRoleFromInstanceProfile(input: AWS.IAM.RemoveRoleFromInstanceProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified user from the specified group. */ removeUserFromGroup(input: AWS.IAM.RemoveUserFromGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. */ resetServiceSpecificCredential(input: AWS.IAM.ResetServiceSpecificCredentialRequest, options: SdkCallOptions): Promise; /** * Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide. */ resyncMFADevice(input: AWS.IAM.ResyncMFADeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the specified version of the specified policy as the policy's default (operative) version. This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. For information about managed policies, see Managed policies and inline policies in the IAM User Guide. */ setDefaultPolicyVersion(input: AWS.IAM.SetDefaultPolicyVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account. By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services General Reference. If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide. To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation. */ setSecurityTokenServicePreferences(input: AWS.IAM.SetSecurityTokenServicePreferencesRequest, options: SdkCallOptions): Promise<{}>; /** * Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account. If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead. Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy. If the output is long, you can use MaxItems and Marker parameters to paginate the results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide. */ simulateCustomPolicy(input: AWS.IAM.SimulateCustomPolicyRequest, options: SdkCallOptions): Promise; /** * Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account. You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead. You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation. The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead. Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy. If the output is long, you can use the MaxItems and Marker parameters to paginate the results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide. */ simulatePrincipalPolicy(input: AWS.IAM.SimulatePrincipalPolicyRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value. Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. */ tagInstanceProfile(input: AWS.IAM.TagInstanceProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. */ tagMFADevice(input: AWS.IAM.TagMFADeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. */ tagOpenIDConnectProvider(input: AWS.IAM.TagOpenIDConnectProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. */ tagPolicy(input: AWS.IAM.TagPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide. Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. For more information about tagging, see Tagging IAM identities in the IAM User Guide. */ tagRole(input: AWS.IAM.TagRoleRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. */ tagSAMLProvider(input: AWS.IAM.TagSAMLProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value. For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide. Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. */ tagServerCertificate(input: AWS.IAM.TagServerCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value. A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following: Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200. Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide. Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. For more information about tagging, see Tagging IAM identities in the IAM User Guide. */ tagUser(input: AWS.IAM.TagUserRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ untagInstanceProfile(input: AWS.IAM.UntagInstanceProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ untagMFADevice(input: AWS.IAM.UntagMFADeviceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ untagOpenIDConnectProvider(input: AWS.IAM.UntagOpenIDConnectProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ untagPolicy(input: AWS.IAM.UntagPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ untagRole(input: AWS.IAM.UntagRoleRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ untagSAMLProvider(input: AWS.IAM.UntagSAMLProviderRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide. For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide. */ untagServerCertificate(input: AWS.IAM.UntagServerCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide. */ untagUser(input: AWS.IAM.UntagUserRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow. If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users. For information about rotating keys, see Managing keys and certificates in the IAM User Guide. */ updateAccessKey(input: AWS.IAM.UpdateAccessKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the password policy settings for the Amazon Web Services account. This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation. For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide. */ updateAccountPasswordPolicy(input: AWS.IAM.UpdateAccountPasswordPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, see Using roles to delegate permissions and federate identities. */ updateAssumeRolePolicy(input: AWS.IAM.UpdateAssumeRolePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the name and/or the path of the specified IAM group. You should understand the implications of changing a group's path or name. For more information, see Renaming users and groups in the IAM User Guide. The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access management. */ updateGroup(input: AWS.IAM.UpdateGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console. For more information about modifying passwords, see Managing passwords in the IAM User Guide. */ updateLoginProfile(input: AWS.IAM.UpdateLoginProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints. The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.) Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated. Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation. Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users. */ updateOpenIDConnectProviderThumbprint(input: AWS.IAM.UpdateOpenIDConnectProviderThumbprintRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the description or maximum session duration setting of a role. */ updateRole(input: AWS.IAM.UpdateRoleRequest, options: SdkCallOptions): Promise; /** * Use UpdateRole instead. Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation. */ updateRoleDescription(input: AWS.IAM.UpdateRoleDescriptionRequest, options: SdkCallOptions): Promise; /** * Updates the metadata document for an existing SAML provider resource object. This operation requires Signature Version 4. */ updateSAMLProvider(input: AWS.IAM.UpdateSAMLProviderRequest, options: SdkCallOptions): Promise; /** * Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow. The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide. */ updateSSHPublicKey(input: AWS.IAM.UpdateSSHPublicKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the name and/or the path of the specified server certificate stored in IAM. For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM. You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificate in the IAM User Guide. The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide. */ updateServerCertificate(input: AWS.IAM.UpdateServerCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow. */ updateServiceSpecificCredential(input: AWS.IAM.UpdateServiceSpecificCredentialRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow. If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users. */ updateSigningCertificate(input: AWS.IAM.UpdateSigningCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the name and/or the path of the specified IAM user. You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide. To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies. */ updateUser(input: AWS.IAM.UpdateUserRequest, options: SdkCallOptions): Promise<{}>; /** * Uploads an SSH public key and associates it with the specified IAM user. The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide. */ uploadSSHPublicKey(input: AWS.IAM.UploadSSHPublicKeyRequest, options: SdkCallOptions): Promise; /** * Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded. We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide. For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM. For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide. Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Calling the API by making HTTP query requests in the IAM User Guide. */ uploadServerCertificate(input: AWS.IAM.UploadServerCertificateRequest, options: SdkCallOptions): Promise; /** * Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active. For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide. If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users. Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide. */ uploadSigningCertificate(input: AWS.IAM.UploadSigningCertificateRequest, options: SdkCallOptions): Promise; } export interface IdentityStore { /** * Creates a group within the specified identity store. */ createGroup(input: AWS.IdentityStore.CreateGroupRequest, options: SdkCallOptions): Promise; /** * Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId. */ createGroupMembership(input: AWS.IdentityStore.CreateGroupMembershipRequest, options: SdkCallOptions): Promise; /** * Creates a new user within the specified identity store. */ createUser(input: AWS.IdentityStore.CreateUserRequest, options: SdkCallOptions): Promise; /** * Delete a group within an identity store given GroupId. */ deleteGroup(input: AWS.IdentityStore.DeleteGroupRequest, options: SdkCallOptions): Promise; /** * Delete a membership within a group given MembershipId. */ deleteGroupMembership(input: AWS.IdentityStore.DeleteGroupMembershipRequest, options: SdkCallOptions): Promise; /** * Deletes a user within an identity store given UserId. */ deleteUser(input: AWS.IdentityStore.DeleteUserRequest, options: SdkCallOptions): Promise; /** * Retrieves the group metadata and attributes from GroupId in an identity store. */ describeGroup(input: AWS.IdentityStore.DescribeGroupRequest, options: SdkCallOptions): Promise; /** * Retrieves membership metadata and attributes from MembershipId in an identity store. */ describeGroupMembership(input: AWS.IdentityStore.DescribeGroupMembershipRequest, options: SdkCallOptions): Promise; /** * Retrieves the user metadata and attributes from the UserId in an identity store. */ describeUser(input: AWS.IdentityStore.DescribeUserRequest, options: SdkCallOptions): Promise; /** * Retrieves GroupId in an identity store. */ getGroupId(input: AWS.IdentityStore.GetGroupIdRequest, options: SdkCallOptions): Promise; /** * Retrieves the MembershipId in an identity store. */ getGroupMembershipId(input: AWS.IdentityStore.GetGroupMembershipIdRequest, options: SdkCallOptions): Promise; /** * Retrieves the UserId in an identity store. */ getUserId(input: AWS.IdentityStore.GetUserIdRequest, options: SdkCallOptions): Promise; /** * Checks the user's membership in all requested groups and returns if the member exists in all queried groups. */ isMemberInGroups(input: AWS.IdentityStore.IsMemberInGroupsRequest, options: SdkCallOptions): Promise; /** * For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form. */ listGroupMemberships(input: AWS.IdentityStore.ListGroupMembershipsRequest, options: SdkCallOptions): Promise; /** * For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form. */ listGroupMembershipsForMember(input: AWS.IdentityStore.ListGroupMembershipsForMemberRequest, options: SdkCallOptions): Promise; /** * Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action. */ listGroups(input: AWS.IdentityStore.ListGroupsRequest, options: SdkCallOptions): Promise; /** * Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action. */ listUsers(input: AWS.IdentityStore.ListUsersRequest, options: SdkCallOptions): Promise; /** * For the specified group in the specified identity store, updates the group metadata and attributes. */ updateGroup(input: AWS.IdentityStore.UpdateGroupRequest, options: SdkCallOptions): Promise; /** * For the specified user in the specified identity store, updates the user metadata and attributes. */ updateUser(input: AWS.IdentityStore.UpdateUserRequest, options: SdkCallOptions): Promise; } export interface Imagebuilder { /** * CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state. */ cancelImageCreation(input: AWS.Imagebuilder.CancelImageCreationRequest, options: SdkCallOptions): Promise; /** * Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods: Inline, using the data property in the request body. A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body. */ createComponent(input: AWS.Imagebuilder.CreateComponentRequest, options: SdkCallOptions): Promise; /** * Creates a new container recipe. Container recipes define how images are configured, tested, and assessed. */ createContainerRecipe(input: AWS.Imagebuilder.CreateContainerRecipeRequest, options: SdkCallOptions): Promise; /** * Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline. */ createDistributionConfiguration(input: AWS.Imagebuilder.CreateDistributionConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn. */ createImage(input: AWS.Imagebuilder.CreateImageRequest, options: SdkCallOptions): Promise; /** * Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images. */ createImagePipeline(input: AWS.Imagebuilder.CreateImagePipelineRequest, options: SdkCallOptions): Promise; /** * Creates a new image recipe. Image recipes define how images are configured, tested, and assessed. */ createImageRecipe(input: AWS.Imagebuilder.CreateImageRecipeRequest, options: SdkCallOptions): Promise; /** * Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested. */ createInfrastructureConfiguration(input: AWS.Imagebuilder.CreateInfrastructureConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a component build version. */ deleteComponent(input: AWS.Imagebuilder.DeleteComponentRequest, options: SdkCallOptions): Promise; /** * Deletes a container recipe. */ deleteContainerRecipe(input: AWS.Imagebuilder.DeleteContainerRecipeRequest, options: SdkCallOptions): Promise; /** * Deletes a distribution configuration. */ deleteDistributionConfiguration(input: AWS.Imagebuilder.DeleteDistributionConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands. To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide . To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide . To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide. */ deleteImage(input: AWS.Imagebuilder.DeleteImageRequest, options: SdkCallOptions): Promise; /** * Deletes an image pipeline. */ deleteImagePipeline(input: AWS.Imagebuilder.DeleteImagePipelineRequest, options: SdkCallOptions): Promise; /** * Deletes an image recipe. */ deleteImageRecipe(input: AWS.Imagebuilder.DeleteImageRecipeRequest, options: SdkCallOptions): Promise; /** * Deletes an infrastructure configuration. */ deleteInfrastructureConfiguration(input: AWS.Imagebuilder.DeleteInfrastructureConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets a component object. */ getComponent(input: AWS.Imagebuilder.GetComponentRequest, options: SdkCallOptions): Promise; /** * Gets a component policy. */ getComponentPolicy(input: AWS.Imagebuilder.GetComponentPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves a container recipe. */ getContainerRecipe(input: AWS.Imagebuilder.GetContainerRecipeRequest, options: SdkCallOptions): Promise; /** * Retrieves the policy for a container recipe. */ getContainerRecipePolicy(input: AWS.Imagebuilder.GetContainerRecipePolicyRequest, options: SdkCallOptions): Promise; /** * Gets a distribution configuration. */ getDistributionConfiguration(input: AWS.Imagebuilder.GetDistributionConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets an image. */ getImage(input: AWS.Imagebuilder.GetImageRequest, options: SdkCallOptions): Promise; /** * Gets an image pipeline. */ getImagePipeline(input: AWS.Imagebuilder.GetImagePipelineRequest, options: SdkCallOptions): Promise; /** * Gets an image policy. */ getImagePolicy(input: AWS.Imagebuilder.GetImagePolicyRequest, options: SdkCallOptions): Promise; /** * Gets an image recipe. */ getImageRecipe(input: AWS.Imagebuilder.GetImageRecipeRequest, options: SdkCallOptions): Promise; /** * Gets an image recipe policy. */ getImageRecipePolicy(input: AWS.Imagebuilder.GetImageRecipePolicyRequest, options: SdkCallOptions): Promise; /** * Gets an infrastructure configuration. */ getInfrastructureConfiguration(input: AWS.Imagebuilder.GetInfrastructureConfigurationRequest, options: SdkCallOptions): Promise; /** * Imports a component and transforms its data into a component document. */ importComponent(input: AWS.Imagebuilder.ImportComponentRequest, options: SdkCallOptions): Promise; /** * When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe. */ importVmImage(input: AWS.Imagebuilder.ImportVmImageRequest, options: SdkCallOptions): Promise; /** * Returns the list of component build versions for the specified semantic version. The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. */ listComponentBuildVersions(input: AWS.Imagebuilder.ListComponentBuildVersionsRequest, options: SdkCallOptions): Promise; /** * Returns the list of component build versions for the specified semantic version. The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. */ listComponents(input: AWS.Imagebuilder.ListComponentsRequest, options: SdkCallOptions): Promise; /** * Returns a list of container recipes. */ listContainerRecipes(input: AWS.Imagebuilder.ListContainerRecipesRequest, options: SdkCallOptions): Promise; /** * Returns a list of distribution configurations. */ listDistributionConfigurations(input: AWS.Imagebuilder.ListDistributionConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of image build versions. */ listImageBuildVersions(input: AWS.Imagebuilder.ListImageBuildVersionsRequest, options: SdkCallOptions): Promise; /** * List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time. */ listImagePackages(input: AWS.Imagebuilder.ListImagePackagesRequest, options: SdkCallOptions): Promise; /** * Returns a list of images created by the specified pipeline. */ listImagePipelineImages(input: AWS.Imagebuilder.ListImagePipelineImagesRequest, options: SdkCallOptions): Promise; /** * Returns a list of image pipelines. */ listImagePipelines(input: AWS.Imagebuilder.ListImagePipelinesRequest, options: SdkCallOptions): Promise; /** * Returns a list of image recipes. */ listImageRecipes(input: AWS.Imagebuilder.ListImageRecipesRequest, options: SdkCallOptions): Promise; /** * Returns the list of images that you have access to. */ listImages(input: AWS.Imagebuilder.ListImagesRequest, options: SdkCallOptions): Promise; /** * Returns a list of infrastructure configurations. */ listInfrastructureConfigurations(input: AWS.Imagebuilder.ListInfrastructureConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns the list of tags for the specified resource. */ listTagsForResource(input: AWS.Imagebuilder.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared. */ putComponentPolicy(input: AWS.Imagebuilder.PutComponentPolicyRequest, options: SdkCallOptions): Promise; /** * Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared. */ putContainerRecipePolicy(input: AWS.Imagebuilder.PutContainerRecipePolicyRequest, options: SdkCallOptions): Promise; /** * Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared. */ putImagePolicy(input: AWS.Imagebuilder.PutImagePolicyRequest, options: SdkCallOptions): Promise; /** * Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared. */ putImageRecipePolicy(input: AWS.Imagebuilder.PutImageRecipePolicyRequest, options: SdkCallOptions): Promise; /** * Manually triggers a pipeline to create an image. */ startImagePipelineExecution(input: AWS.Imagebuilder.StartImagePipelineExecutionRequest, options: SdkCallOptions): Promise; /** * Adds a tag to a resource. */ tagResource(input: AWS.Imagebuilder.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from a resource. */ untagResource(input: AWS.Imagebuilder.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline. */ updateDistributionConfiguration(input: AWS.Imagebuilder.UpdateDistributionConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed. */ updateImagePipeline(input: AWS.Imagebuilder.UpdateImagePipelineRequest, options: SdkCallOptions): Promise; /** * Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested. */ updateInfrastructureConfiguration(input: AWS.Imagebuilder.UpdateInfrastructureConfigurationRequest, options: SdkCallOptions): Promise; } export interface ImportExport { /** * This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete. */ cancelJob(input: AWS.ImportExport.CancelJobInput, options: SdkCallOptions): Promise; /** * This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device. */ createJob(input: AWS.ImportExport.CreateJobInput, options: SdkCallOptions): Promise; /** * This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing. */ getShippingLabel(input: AWS.ImportExport.GetShippingLabelInput, options: SdkCallOptions): Promise; /** * This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. */ getStatus(input: AWS.ImportExport.GetStatusInput, options: SdkCallOptions): Promise; /** * This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1. */ listJobs(input: AWS.ImportExport.ListJobsInput, options: SdkCallOptions): Promise; /** * You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own. */ updateJob(input: AWS.ImportExport.UpdateJobInput, options: SdkCallOptions): Promise; } export interface Inspector { /** * Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings. */ addAttributesToFindings(input: AWS.Inspector.AddAttributesToFindingsRequest, options: SdkCallOptions): Promise; /** * Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets. */ createAssessmentTarget(input: AWS.Inspector.CreateAssessmentTargetRequest, options: SdkCallOptions): Promise; /** * Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. */ createAssessmentTemplate(input: AWS.Inspector.CreateAssessmentTemplateRequest, options: SdkCallOptions): Promise; /** * Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment. */ createExclusionsPreview(input: AWS.Inspector.CreateExclusionsPreviewRequest, options: SdkCallOptions): Promise; /** * Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget. */ createResourceGroup(input: AWS.Inspector.CreateResourceGroupRequest, options: SdkCallOptions): Promise; /** * Deletes the assessment run that is specified by the ARN of the assessment run. */ deleteAssessmentRun(input: AWS.Inspector.DeleteAssessmentRunRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the assessment target that is specified by the ARN of the assessment target. */ deleteAssessmentTarget(input: AWS.Inspector.DeleteAssessmentTargetRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the assessment template that is specified by the ARN of the assessment template. */ deleteAssessmentTemplate(input: AWS.Inspector.DeleteAssessmentTemplateRequest, options: SdkCallOptions): Promise<{}>; /** * Describes the assessment runs that are specified by the ARNs of the assessment runs. */ describeAssessmentRuns(input: AWS.Inspector.DescribeAssessmentRunsRequest, options: SdkCallOptions): Promise; /** * Describes the assessment targets that are specified by the ARNs of the assessment targets. */ describeAssessmentTargets(input: AWS.Inspector.DescribeAssessmentTargetsRequest, options: SdkCallOptions): Promise; /** * Describes the assessment templates that are specified by the ARNs of the assessment templates. */ describeAssessmentTemplates(input: AWS.Inspector.DescribeAssessmentTemplatesRequest, options: SdkCallOptions): Promise; /** * Describes the exclusions that are specified by the exclusions' ARNs. */ describeExclusions(input: AWS.Inspector.DescribeExclusionsRequest, options: SdkCallOptions): Promise; /** * Describes the findings that are specified by the ARNs of the findings. */ describeFindings(input: AWS.Inspector.DescribeFindingsRequest, options: SdkCallOptions): Promise; /** * Describes the resource groups that are specified by the ARNs of the resource groups. */ describeResourceGroups(input: AWS.Inspector.DescribeResourceGroupsRequest, options: SdkCallOptions): Promise; /** * Describes the rules packages that are specified by the ARNs of the rules packages. */ describeRulesPackages(input: AWS.Inspector.DescribeRulesPackagesRequest, options: SdkCallOptions): Promise; /** * Produces an assessment report that includes detailed and comprehensive results of a specified assessment run. */ getAssessmentReport(input: AWS.Inspector.GetAssessmentReportRequest, options: SdkCallOptions): Promise; /** * Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API. */ getExclusionsPreview(input: AWS.Inspector.GetExclusionsPreviewRequest, options: SdkCallOptions): Promise; /** * Information about the data that is collected for the specified assessment run. */ getTelemetryMetadata(input: AWS.Inspector.GetTelemetryMetadataRequest, options: SdkCallOptions): Promise; /** * Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs. */ listAssessmentRunAgents(input: AWS.Inspector.ListAssessmentRunAgentsRequest, options: SdkCallOptions): Promise; /** * Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates. */ listAssessmentRuns(input: AWS.Inspector.ListAssessmentRunsRequest, options: SdkCallOptions): Promise; /** * Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets. */ listAssessmentTargets(input: AWS.Inspector.ListAssessmentTargetsRequest, options: SdkCallOptions): Promise; /** * Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets. */ listAssessmentTemplates(input: AWS.Inspector.ListAssessmentTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent. */ listEventSubscriptions(input: AWS.Inspector.ListEventSubscriptionsRequest, options: SdkCallOptions): Promise; /** * List exclusions that are generated by the assessment run. */ listExclusions(input: AWS.Inspector.ListExclusionsRequest, options: SdkCallOptions): Promise; /** * Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs. */ listFindings(input: AWS.Inspector.ListFindingsRequest, options: SdkCallOptions): Promise; /** * Lists all available Amazon Inspector rules packages. */ listRulesPackages(input: AWS.Inspector.ListRulesPackagesRequest, options: SdkCallOptions): Promise; /** * Lists all tags associated with an assessment template. */ listTagsForResource(input: AWS.Inspector.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Previews the agents installed on the EC2 instances that are part of the specified assessment target. */ previewAgents(input: AWS.Inspector.PreviewAgentsRequest, options: SdkCallOptions): Promise; /** * Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments. */ registerCrossAccountAccessRole(input: AWS.Inspector.RegisterCrossAccountAccessRoleRequest, options: SdkCallOptions): Promise<{}>; /** * Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists. */ removeAttributesFromFindings(input: AWS.Inspector.RemoveAttributesFromFindingsRequest, options: SdkCallOptions): Promise; /** * Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template. */ setTagsForResource(input: AWS.Inspector.SetTagsForResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account. */ startAssessmentRun(input: AWS.Inspector.StartAssessmentRunRequest, options: SdkCallOptions): Promise; /** * Stops the assessment run that is specified by the ARN of the assessment run. */ stopAssessmentRun(input: AWS.Inspector.StopAssessmentRunRequest, options: SdkCallOptions): Promise<{}>; /** * Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. */ subscribeToEvent(input: AWS.Inspector.SubscribeToEventRequest, options: SdkCallOptions): Promise<{}>; /** * Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. */ unsubscribeFromEvent(input: AWS.Inspector.UnsubscribeFromEventRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the assessment target that is specified by the ARN of the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. */ updateAssessmentTarget(input: AWS.Inspector.UpdateAssessmentTargetRequest, options: SdkCallOptions): Promise<{}>; } export interface Inspector2 { /** * Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. */ associateMember(input: AWS.Inspector2.AssociateMemberRequest, options: SdkCallOptions): Promise; /** * Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment. */ batchGetAccountStatus(input: AWS.Inspector2.BatchGetAccountStatusRequest, options: SdkCallOptions): Promise; /** * Gets free trial status for multiple Amazon Web Services accounts. */ batchGetFreeTrialInfo(input: AWS.Inspector2.BatchGetFreeTrialInfoRequest, options: SdkCallOptions): Promise; /** * Cancels the given findings report. */ cancelFindingsReport(input: AWS.Inspector2.CancelFindingsReportRequest, options: SdkCallOptions): Promise; /** * Creates a filter resource using specified filter criteria. */ createFilter(input: AWS.Inspector2.CreateFilterRequest, options: SdkCallOptions): Promise; /** * Creates a finding report. */ createFindingsReport(input: AWS.Inspector2.CreateFindingsReportRequest, options: SdkCallOptions): Promise; /** * Deletes a filter resource. */ deleteFilter(input: AWS.Inspector2.DeleteFilterRequest, options: SdkCallOptions): Promise; /** * Describe Amazon Inspector configuration settings for an Amazon Web Services organization */ describeOrganizationConfiguration(input: AWS.Inspector2.DescribeOrganizationConfigurationRequest, options: SdkCallOptions): Promise; /** * Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service. */ disable(input: AWS.Inspector2.DisableRequest, options: SdkCallOptions): Promise; /** * Disables the Amazon Inspector delegated administrator for your organization. */ disableDelegatedAdminAccount(input: AWS.Inspector2.DisableDelegatedAdminAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates a member account from an Amazon Inspector delegated administrator. */ disassociateMember(input: AWS.Inspector2.DisassociateMemberRequest, options: SdkCallOptions): Promise; /** * Enables Amazon Inspector scans for one or more Amazon Web Services accounts. */ enable(input: AWS.Inspector2.EnableRequest, options: SdkCallOptions): Promise; /** * Enables the Amazon Inspector delegated administrator for your Organizations organization. */ enableDelegatedAdminAccount(input: AWS.Inspector2.EnableDelegatedAdminAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves setting configurations for Inspector scans. */ getConfiguration(input: AWS.Inspector2.GetConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the Amazon Inspector delegated administrator for your organization. */ getDelegatedAdminAccount(input: AWS.Inspector2.GetDelegatedAdminAccountRequest, options: SdkCallOptions): Promise; /** * Gets the status of a findings report. */ getFindingsReportStatus(input: AWS.Inspector2.GetFindingsReportStatusRequest, options: SdkCallOptions): Promise; /** * Gets member information for your organization. */ getMember(input: AWS.Inspector2.GetMemberRequest, options: SdkCallOptions): Promise; /** * Lists the permissions an account has to configure Amazon Inspector. */ listAccountPermissions(input: AWS.Inspector2.ListAccountPermissionsRequest, options: SdkCallOptions): Promise; /** * Lists coverage details for you environment. */ listCoverage(input: AWS.Inspector2.ListCoverageRequest, options: SdkCallOptions): Promise; /** * Lists Amazon Inspector coverage statistics for your environment. */ listCoverageStatistics(input: AWS.Inspector2.ListCoverageStatisticsRequest, options: SdkCallOptions): Promise; /** * Lists information about the Amazon Inspector delegated administrator of your organization. */ listDelegatedAdminAccounts(input: AWS.Inspector2.ListDelegatedAdminAccountsRequest, options: SdkCallOptions): Promise; /** * Lists the filters associated with your account. */ listFilters(input: AWS.Inspector2.ListFiltersRequest, options: SdkCallOptions): Promise; /** * Lists aggregated finding data for your environment based on specific criteria. */ listFindingAggregations(input: AWS.Inspector2.ListFindingAggregationsRequest, options: SdkCallOptions): Promise; /** * Lists findings for your environment. */ listFindings(input: AWS.Inspector2.ListFindingsRequest, options: SdkCallOptions): Promise; /** * List members associated with the Amazon Inspector delegated administrator for your organization. */ listMembers(input: AWS.Inspector2.ListMembersRequest, options: SdkCallOptions): Promise; /** * Lists all tags attached to a given resource. */ listTagsForResource(input: AWS.Inspector2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon Inspector usage totals over the last 30 days. */ listUsageTotals(input: AWS.Inspector2.ListUsageTotalsRequest, options: SdkCallOptions): Promise; /** * Adds tags to a resource. */ tagResource(input: AWS.Inspector2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource. */ untagResource(input: AWS.Inspector2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting. */ updateConfiguration(input: AWS.Inspector2.UpdateConfigurationRequest, options: SdkCallOptions): Promise; /** * Specifies the action that is to be applied to the findings that match the filter. */ updateFilter(input: AWS.Inspector2.UpdateFilterRequest, options: SdkCallOptions): Promise; /** * Updates the configurations for your Amazon Inspector organization. */ updateOrganizationConfiguration(input: AWS.Inspector2.UpdateOrganizationConfigurationRequest, options: SdkCallOptions): Promise; } export interface Iot { /** * Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. Requires permission to access the AcceptCertificateTransfer action. */ acceptCertificateTransfer(input: AWS.Iot.AcceptCertificateTransferRequest, options: SdkCallOptions): Promise<{}>; /** * Adds a thing to a billing group. Requires permission to access the AddThingToBillingGroup action. */ addThingToBillingGroup(input: AWS.Iot.AddThingToBillingGroupRequest, options: SdkCallOptions): Promise; /** * Adds a thing to a thing group. Requires permission to access the AddThingToThingGroup action. */ addThingToThingGroup(input: AWS.Iot.AddThingToThingGroupRequest, options: SdkCallOptions): Promise; /** * Associates a group with a continuous job. The following criteria must be met: The job must have been created with the targetSelection field set to "CONTINUOUS". The job status must currently be "IN_PROGRESS". The total number of targets associated with a job must not exceed 100. Requires permission to access the AssociateTargetsWithJob action. */ associateTargetsWithJob(input: AWS.Iot.AssociateTargetsWithJobRequest, options: SdkCallOptions): Promise; /** * Attaches the specified policy to the specified principal (certificate or other credential). Requires permission to access the AttachPolicy action. */ attachPolicy(input: AWS.Iot.AttachPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Attaches the specified policy to the specified principal (certificate or other credential). Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead. Requires permission to access the AttachPrincipalPolicy action. */ attachPrincipalPolicy(input: AWS.Iot.AttachPrincipalPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it. Requires permission to access the AttachSecurityProfile action. */ attachSecurityProfile(input: AWS.Iot.AttachSecurityProfileRequest, options: SdkCallOptions): Promise; /** * Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. Requires permission to access the AttachThingPrincipal action. */ attachThingPrincipal(input: AWS.Iot.AttachThingPrincipalRequest, options: SdkCallOptions): Promise; /** * Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs. Requires permission to access the CancelAuditMitigationActionsTask action. */ cancelAuditMitigationActionsTask(input: AWS.Iot.CancelAuditMitigationActionsTaskRequest, options: SdkCallOptions): Promise; /** * Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs. Requires permission to access the CancelAuditTask action. */ cancelAuditTask(input: AWS.Iot.CancelAuditTaskRequest, options: SdkCallOptions): Promise; /** * Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE. Requires permission to access the CancelCertificateTransfer action. */ cancelCertificateTransfer(input: AWS.Iot.CancelCertificateTransferRequest, options: SdkCallOptions): Promise<{}>; /** * Cancels a Device Defender ML Detect mitigation action. Requires permission to access the CancelDetectMitigationActionsTask action. */ cancelDetectMitigationActionsTask(input: AWS.Iot.CancelDetectMitigationActionsTaskRequest, options: SdkCallOptions): Promise; /** * Cancels a job. Requires permission to access the CancelJob action. */ cancelJob(input: AWS.Iot.CancelJobRequest, options: SdkCallOptions): Promise; /** * Cancels the execution of a job for a given thing. Requires permission to access the CancelJobExecution action. */ cancelJobExecution(input: AWS.Iot.CancelJobExecutionRequest, options: SdkCallOptions): Promise<{}>; /** * Clears the default authorizer. Requires permission to access the ClearDefaultAuthorizer action. */ clearDefaultAuthorizer(input: AWS.Iot.ClearDefaultAuthorizerRequest, options: SdkCallOptions): Promise; /** * Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint. Requires permission to access the ConfirmTopicRuleDestination action. */ confirmTopicRuleDestination(input: AWS.Iot.ConfirmTopicRuleDestinationRequest, options: SdkCallOptions): Promise; /** * Creates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action. */ createAuditSuppression(input: AWS.Iot.CreateAuditSuppressionRequest, options: SdkCallOptions): Promise; /** * Creates an authorizer. Requires permission to access the CreateAuthorizer action. */ createAuthorizer(input: AWS.Iot.CreateAuthorizerRequest, options: SdkCallOptions): Promise; /** * Creates a billing group. Requires permission to access the CreateBillingGroup action. */ createBillingGroup(input: AWS.Iot.CreateBillingGroupRequest, options: SdkCallOptions): Promise; /** * Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-512 curves. For supported certificates, consult Certificate signing algorithms supported by IoT. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. Requires permission to access the CreateCertificateFromCsr action. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path" */ createCertificateFromCsr(input: AWS.Iot.CreateCertificateFromCsrRequest, options: SdkCallOptions): Promise; /** * Use this API to define a Custom Metric published by your devices to Device Defender. Requires permission to access the CreateCustomMetric action. */ createCustomMetric(input: AWS.Iot.CreateCustomMetricRequest, options: SdkCallOptions): Promise; /** * Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension. Requires permission to access the CreateDimension action. */ createDimension(input: AWS.Iot.CreateDimensionRequest, options: SdkCallOptions): Promise; /** * Creates a domain configuration. Requires permission to access the CreateDomainConfiguration action. */ createDomainConfiguration(input: AWS.Iot.CreateDomainConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a dynamic thing group. Requires permission to access the CreateDynamicThingGroup action. */ createDynamicThingGroup(input: AWS.Iot.CreateDynamicThingGroupRequest, options: SdkCallOptions): Promise; /** * Creates a fleet metric. Requires permission to access the CreateFleetMetric action. */ createFleetMetric(input: AWS.Iot.CreateFleetMetricRequest, options: SdkCallOptions): Promise; /** * Creates a job. Requires permission to access the CreateJob action. */ createJob(input: AWS.Iot.CreateJobRequest, options: SdkCallOptions): Promise; /** * Creates a job template. Requires permission to access the CreateJobTemplate action. */ createJobTemplate(input: AWS.Iot.CreateJobTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API. Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location. Requires permission to access the CreateKeysAndCertificate action. */ createKeysAndCertificate(input: AWS.Iot.CreateKeysAndCertificateRequest, options: SdkCallOptions): Promise; /** * Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change. Requires permission to access the CreateMitigationAction action. */ createMitigationAction(input: AWS.Iot.CreateMitigationActionRequest, options: SdkCallOptions): Promise; /** * Creates an IoT OTA update on a target group of things or groups. Requires permission to access the CreateOTAUpdate action. */ createOTAUpdate(input: AWS.Iot.CreateOTAUpdateRequest, options: SdkCallOptions): Promise; /** * Creates an IoT policy. The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version. Requires permission to access the CreatePolicy action. */ createPolicy(input: AWS.Iot.CreatePolicyRequest, options: SdkCallOptions): Promise; /** * Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached). Requires permission to access the CreatePolicyVersion action. */ createPolicyVersion(input: AWS.Iot.CreatePolicyVersionRequest, options: SdkCallOptions): Promise; /** * Creates a provisioning claim. Requires permission to access the CreateProvisioningClaim action. */ createProvisioningClaim(input: AWS.Iot.CreateProvisioningClaimRequest, options: SdkCallOptions): Promise; /** * Creates a provisioning template. Requires permission to access the CreateProvisioningTemplate action. */ createProvisioningTemplate(input: AWS.Iot.CreateProvisioningTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a new version of a provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action. */ createProvisioningTemplateVersion(input: AWS.Iot.CreateProvisioningTemplateVersionRequest, options: SdkCallOptions): Promise; /** * Creates a role alias. Requires permission to access the CreateRoleAlias action. */ createRoleAlias(input: AWS.Iot.CreateRoleAliasRequest, options: SdkCallOptions): Promise; /** * Creates a scheduled audit that is run at a specified time interval. Requires permission to access the CreateScheduledAudit action. */ createScheduledAudit(input: AWS.Iot.CreateScheduledAuditRequest, options: SdkCallOptions): Promise; /** * Creates a Device Defender security profile. Requires permission to access the CreateSecurityProfile action. */ createSecurityProfile(input: AWS.Iot.CreateSecurityProfileRequest, options: SdkCallOptions): Promise; /** * Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. Requires permission to access the CreateStream action. */ createStream(input: AWS.Iot.CreateStreamRequest, options: SdkCallOptions): Promise; /** * Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown. This is a control plane operation. See Authorization for information about authorizing control plane actions. Requires permission to access the CreateThing action. */ createThing(input: AWS.Iot.CreateThingRequest, options: SdkCallOptions): Promise; /** * Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions. Requires permission to access the CreateThingGroup action. */ createThingGroup(input: AWS.Iot.CreateThingGroupRequest, options: SdkCallOptions): Promise; /** * Creates a new thing type. Requires permission to access the CreateThingType action. */ createThingType(input: AWS.Iot.CreateThingTypeRequest, options: SdkCallOptions): Promise; /** * Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. Requires permission to access the CreateTopicRule action. */ createTopicRule(input: AWS.Iot.CreateTopicRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action. */ createTopicRuleDestination(input: AWS.Iot.CreateTopicRuleDestinationRequest, options: SdkCallOptions): Promise; /** * Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled. Requires permission to access the DeleteAccountAuditConfiguration action. */ deleteAccountAuditConfiguration(input: AWS.Iot.DeleteAccountAuditConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action. */ deleteAuditSuppression(input: AWS.Iot.DeleteAuditSuppressionRequest, options: SdkCallOptions): Promise; /** * Deletes an authorizer. Requires permission to access the DeleteAuthorizer action. */ deleteAuthorizer(input: AWS.Iot.DeleteAuthorizerRequest, options: SdkCallOptions): Promise; /** * Deletes the billing group. Requires permission to access the DeleteBillingGroup action. */ deleteBillingGroup(input: AWS.Iot.DeleteBillingGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a registered CA certificate. Requires permission to access the DeleteCACertificate action. */ deleteCACertificate(input: AWS.Iot.DeleteCACertificateRequest, options: SdkCallOptions): Promise; /** * Deletes the specified certificate. A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status. Requires permission to access the DeleteCertificate action. */ deleteCertificate(input: AWS.Iot.DeleteCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Device Defender detect custom metric. Requires permission to access the DeleteCustomMetric action. Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name. */ deleteCustomMetric(input: AWS.Iot.DeleteCustomMetricRequest, options: SdkCallOptions): Promise; /** * Removes the specified dimension from your Amazon Web Services accounts. Requires permission to access the DeleteDimension action. */ deleteDimension(input: AWS.Iot.DeleteDimensionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action. */ deleteDomainConfiguration(input: AWS.Iot.DeleteDomainConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a dynamic thing group. Requires permission to access the DeleteDynamicThingGroup action. */ deleteDynamicThingGroup(input: AWS.Iot.DeleteDynamicThingGroupRequest, options: SdkCallOptions): Promise; /** * Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist. Requires permission to access the DeleteFleetMetric action. */ deleteFleetMetric(input: AWS.Iot.DeleteFleetMetricRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a job and its related job executions. Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur. Requires permission to access the DeleteJob action. */ deleteJob(input: AWS.Iot.DeleteJobRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a job execution. Requires permission to access the DeleteJobExecution action. */ deleteJobExecution(input: AWS.Iot.DeleteJobExecutionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified job template. */ deleteJobTemplate(input: AWS.Iot.DeleteJobTemplateRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a defined mitigation action from your Amazon Web Services accounts. Requires permission to access the DeleteMitigationAction action. */ deleteMitigationAction(input: AWS.Iot.DeleteMitigationActionRequest, options: SdkCallOptions): Promise; /** * Delete an OTA update. Requires permission to access the DeleteOTAUpdate action. */ deleteOTAUpdate(input: AWS.Iot.DeleteOTAUpdateRequest, options: SdkCallOptions): Promise; /** * Deletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the DeletePolicyVersion action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it. Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted. Requires permission to access the DeletePolicy action. */ deletePolicy(input: AWS.Iot.DeletePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions. Requires permission to access the DeletePolicyVersion action. */ deletePolicyVersion(input: AWS.Iot.DeletePolicyVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a provisioning template. Requires permission to access the DeleteProvisioningTemplate action. */ deleteProvisioningTemplate(input: AWS.Iot.DeleteProvisioningTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action. */ deleteProvisioningTemplateVersion(input: AWS.Iot.DeleteProvisioningTemplateVersionRequest, options: SdkCallOptions): Promise; /** * Deletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action. */ deleteRegistrationCode(input: AWS.Iot.DeleteRegistrationCodeRequest, options: SdkCallOptions): Promise; /** * Deletes a role alias Requires permission to access the DeleteRoleAlias action. */ deleteRoleAlias(input: AWS.Iot.DeleteRoleAliasRequest, options: SdkCallOptions): Promise; /** * Deletes a scheduled audit. Requires permission to access the DeleteScheduledAudit action. */ deleteScheduledAudit(input: AWS.Iot.DeleteScheduledAuditRequest, options: SdkCallOptions): Promise; /** * Deletes a Device Defender security profile. Requires permission to access the DeleteSecurityProfile action. */ deleteSecurityProfile(input: AWS.Iot.DeleteSecurityProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a stream. Requires permission to access the DeleteStream action. */ deleteStream(input: AWS.Iot.DeleteStreamRequest, options: SdkCallOptions): Promise; /** * Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist. Requires permission to access the DeleteThing action. */ deleteThing(input: AWS.Iot.DeleteThingRequest, options: SdkCallOptions): Promise; /** * Deletes a thing group. Requires permission to access the DeleteThingGroup action. */ deleteThingGroup(input: AWS.Iot.DeleteThingGroupRequest, options: SdkCallOptions): Promise; /** * Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type. Requires permission to access the DeleteThingType action. */ deleteThingType(input: AWS.Iot.DeleteThingTypeRequest, options: SdkCallOptions): Promise; /** * Deletes the rule. Requires permission to access the DeleteTopicRule action. */ deleteTopicRule(input: AWS.Iot.DeleteTopicRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action. */ deleteTopicRuleDestination(input: AWS.Iot.DeleteTopicRuleDestinationRequest, options: SdkCallOptions): Promise; /** * Deletes a logging level. Requires permission to access the DeleteV2LoggingLevel action. */ deleteV2LoggingLevel(input: AWS.Iot.DeleteV2LoggingLevelRequest, options: SdkCallOptions): Promise<{}>; /** * Deprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the DeprecateThingType action. */ deprecateThingType(input: AWS.Iot.DeprecateThingTypeRequest, options: SdkCallOptions): Promise; /** * Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the DescribeAccountAuditConfiguration action. */ describeAccountAuditConfiguration(input: AWS.Iot.DescribeAccountAuditConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding. Requires permission to access the DescribeAuditFinding action. */ describeAuditFinding(input: AWS.Iot.DescribeAuditFindingRequest, options: SdkCallOptions): Promise; /** * Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics. */ describeAuditMitigationActionsTask(input: AWS.Iot.DescribeAuditMitigationActionsTaskRequest, options: SdkCallOptions): Promise; /** * Gets information about a Device Defender audit suppression. */ describeAuditSuppression(input: AWS.Iot.DescribeAuditSuppressionRequest, options: SdkCallOptions): Promise; /** * Gets information about a Device Defender audit. Requires permission to access the DescribeAuditTask action. */ describeAuditTask(input: AWS.Iot.DescribeAuditTaskRequest, options: SdkCallOptions): Promise; /** * Describes an authorizer. Requires permission to access the DescribeAuthorizer action. */ describeAuthorizer(input: AWS.Iot.DescribeAuthorizerRequest, options: SdkCallOptions): Promise; /** * Returns information about a billing group. Requires permission to access the DescribeBillingGroup action. */ describeBillingGroup(input: AWS.Iot.DescribeBillingGroupRequest, options: SdkCallOptions): Promise; /** * Describes a registered CA certificate. Requires permission to access the DescribeCACertificate action. */ describeCACertificate(input: AWS.Iot.DescribeCACertificateRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified certificate. Requires permission to access the DescribeCertificate action. */ describeCertificate(input: AWS.Iot.DescribeCertificateRequest, options: SdkCallOptions): Promise; /** * Gets information about a Device Defender detect custom metric. Requires permission to access the DescribeCustomMetric action. */ describeCustomMetric(input: AWS.Iot.DescribeCustomMetricRequest, options: SdkCallOptions): Promise; /** * Describes the default authorizer. Requires permission to access the DescribeDefaultAuthorizer action. */ describeDefaultAuthorizer(input: AWS.Iot.DescribeDefaultAuthorizerRequest, options: SdkCallOptions): Promise; /** * Gets information about a Device Defender ML Detect mitigation action. Requires permission to access the DescribeDetectMitigationActionsTask action. */ describeDetectMitigationActionsTask(input: AWS.Iot.DescribeDetectMitigationActionsTaskRequest, options: SdkCallOptions): Promise; /** * Provides details about a dimension that is defined in your Amazon Web Services accounts. Requires permission to access the DescribeDimension action. */ describeDimension(input: AWS.Iot.DescribeDimensionRequest, options: SdkCallOptions): Promise; /** * Gets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action. */ describeDomainConfiguration(input: AWS.Iot.DescribeDomainConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns a unique endpoint specific to the Amazon Web Services account making the call. Requires permission to access the DescribeEndpoint action. */ describeEndpoint(input: AWS.Iot.DescribeEndpointRequest, options: SdkCallOptions): Promise; /** * Describes event configurations. Requires permission to access the DescribeEventConfigurations action. */ describeEventConfigurations(input: AWS.Iot.DescribeEventConfigurationsRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified fleet metric. Requires permission to access the DescribeFleetMetric action. */ describeFleetMetric(input: AWS.Iot.DescribeFleetMetricRequest, options: SdkCallOptions): Promise; /** * Describes a search index. Requires permission to access the DescribeIndex action. */ describeIndex(input: AWS.Iot.DescribeIndexRequest, options: SdkCallOptions): Promise; /** * Describes a job. Requires permission to access the DescribeJob action. */ describeJob(input: AWS.Iot.DescribeJobRequest, options: SdkCallOptions): Promise; /** * Describes a job execution. Requires permission to access the DescribeJobExecution action. */ describeJobExecution(input: AWS.Iot.DescribeJobExecutionRequest, options: SdkCallOptions): Promise; /** * Returns information about a job template. */ describeJobTemplate(input: AWS.Iot.DescribeJobTemplateRequest, options: SdkCallOptions): Promise; /** * View details of a managed job template. */ describeManagedJobTemplate(input: AWS.Iot.DescribeManagedJobTemplateRequest, options: SdkCallOptions): Promise; /** * Gets information about a mitigation action. Requires permission to access the DescribeMitigationAction action. */ describeMitigationAction(input: AWS.Iot.DescribeMitigationActionRequest, options: SdkCallOptions): Promise; /** * Returns information about a provisioning template. Requires permission to access the DescribeProvisioningTemplate action. */ describeProvisioningTemplate(input: AWS.Iot.DescribeProvisioningTemplateRequest, options: SdkCallOptions): Promise; /** * Returns information about a provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action. */ describeProvisioningTemplateVersion(input: AWS.Iot.DescribeProvisioningTemplateVersionRequest, options: SdkCallOptions): Promise; /** * Describes a role alias. Requires permission to access the DescribeRoleAlias action. */ describeRoleAlias(input: AWS.Iot.DescribeRoleAliasRequest, options: SdkCallOptions): Promise; /** * Gets information about a scheduled audit. Requires permission to access the DescribeScheduledAudit action. */ describeScheduledAudit(input: AWS.Iot.DescribeScheduledAuditRequest, options: SdkCallOptions): Promise; /** * Gets information about a Device Defender security profile. Requires permission to access the DescribeSecurityProfile action. */ describeSecurityProfile(input: AWS.Iot.DescribeSecurityProfileRequest, options: SdkCallOptions): Promise; /** * Gets information about a stream. Requires permission to access the DescribeStream action. */ describeStream(input: AWS.Iot.DescribeStreamRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified thing. Requires permission to access the DescribeThing action. */ describeThing(input: AWS.Iot.DescribeThingRequest, options: SdkCallOptions): Promise; /** * Describe a thing group. Requires permission to access the DescribeThingGroup action. */ describeThingGroup(input: AWS.Iot.DescribeThingGroupRequest, options: SdkCallOptions): Promise; /** * Describes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action. */ describeThingRegistrationTask(input: AWS.Iot.DescribeThingRegistrationTaskRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified thing type. Requires permission to access the DescribeThingType action. */ describeThingType(input: AWS.Iot.DescribeThingTypeRequest, options: SdkCallOptions): Promise; /** * Detaches a policy from the specified target. Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted. Requires permission to access the DetachPolicy action. */ detachPolicy(input: AWS.Iot.DetachPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified policy from the specified certificate. Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead. Requires permission to access the DetachPrincipalPolicy action. */ detachPrincipalPolicy(input: AWS.Iot.DetachPrincipalPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates a Device Defender security profile from a thing group or from this account. Requires permission to access the DetachSecurityProfile action. */ detachSecurityProfile(input: AWS.Iot.DetachSecurityProfileRequest, options: SdkCallOptions): Promise; /** * Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. This call is asynchronous. It might take several seconds for the detachment to propagate. Requires permission to access the DetachThingPrincipal action. */ detachThingPrincipal(input: AWS.Iot.DetachThingPrincipalRequest, options: SdkCallOptions): Promise; /** * Disables the rule. Requires permission to access the DisableTopicRule action. */ disableTopicRule(input: AWS.Iot.DisableTopicRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Enables the rule. Requires permission to access the EnableTopicRule action. */ enableTopicRule(input: AWS.Iot.EnableTopicRuleRequest, options: SdkCallOptions): Promise<{}>; /** * Returns a Device Defender's ML Detect Security Profile training model's status. Requires permission to access the GetBehaviorModelTrainingSummaries action. */ getBehaviorModelTrainingSummaries(input: AWS.Iot.GetBehaviorModelTrainingSummariesRequest, options: SdkCallOptions): Promise; /** * Aggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action. */ getBucketsAggregation(input: AWS.Iot.GetBucketsAggregationRequest, options: SdkCallOptions): Promise; /** * Returns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action. */ getCardinality(input: AWS.Iot.GetCardinalityRequest, options: SdkCallOptions): Promise; /** * Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway. Requires permission to access the GetEffectivePolicies action. */ getEffectivePolicies(input: AWS.Iot.GetEffectivePoliciesRequest, options: SdkCallOptions): Promise; /** * Gets the indexing configuration. Requires permission to access the GetIndexingConfiguration action. */ getIndexingConfiguration(input: AWS.Iot.GetIndexingConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets a job document. Requires permission to access the GetJobDocument action. */ getJobDocument(input: AWS.Iot.GetJobDocumentRequest, options: SdkCallOptions): Promise; /** * Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions action. */ getLoggingOptions(input: AWS.Iot.GetLoggingOptionsRequest, options: SdkCallOptions): Promise; /** * Gets an OTA update. Requires permission to access the GetOTAUpdate action. */ getOTAUpdate(input: AWS.Iot.GetOTAUpdateRequest, options: SdkCallOptions): Promise; /** * Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values. Requires permission to access the GetPercentiles action. */ getPercentiles(input: AWS.Iot.GetPercentilesRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified policy with the policy document of the default version. Requires permission to access the GetPolicy action. */ getPolicy(input: AWS.Iot.GetPolicyRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified policy version. Requires permission to access the GetPolicyVersion action. */ getPolicyVersion(input: AWS.Iot.GetPolicyVersionRequest, options: SdkCallOptions): Promise; /** * Gets a registration code used to register a CA certificate with IoT. Requires permission to access the GetRegistrationCode action. */ getRegistrationCode(input: AWS.Iot.GetRegistrationCodeRequest, options: SdkCallOptions): Promise; /** * Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned. Requires permission to access the GetStatistics action. */ getStatistics(input: AWS.Iot.GetStatisticsRequest, options: SdkCallOptions): Promise; /** * Gets information about the rule. Requires permission to access the GetTopicRule action. */ getTopicRule(input: AWS.Iot.GetTopicRuleRequest, options: SdkCallOptions): Promise; /** * Gets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action. */ getTopicRuleDestination(input: AWS.Iot.GetTopicRuleDestinationRequest, options: SdkCallOptions): Promise; /** * Gets the fine grained logging options. Requires permission to access the GetV2LoggingOptions action. */ getV2LoggingOptions(input: AWS.Iot.GetV2LoggingOptionsRequest, options: SdkCallOptions): Promise; /** * Lists the active violations for a given Device Defender security profile. Requires permission to access the ListActiveViolations action. */ listActiveViolations(input: AWS.Iot.ListActiveViolationsRequest, options: SdkCallOptions): Promise; /** * Lists the policies attached to the specified thing group. Requires permission to access the ListAttachedPolicies action. */ listAttachedPolicies(input: AWS.Iot.ListAttachedPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.) Requires permission to access the ListAuditFindings action. */ listAuditFindings(input: AWS.Iot.ListAuditFindingsRequest, options: SdkCallOptions): Promise; /** * Gets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions action. */ listAuditMitigationActionsExecutions(input: AWS.Iot.ListAuditMitigationActionsExecutionsRequest, options: SdkCallOptions): Promise; /** * Gets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action. */ listAuditMitigationActionsTasks(input: AWS.Iot.ListAuditMitigationActionsTasksRequest, options: SdkCallOptions): Promise; /** * Lists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action. */ listAuditSuppressions(input: AWS.Iot.ListAuditSuppressionsRequest, options: SdkCallOptions): Promise; /** * Lists the Device Defender audits that have been performed during a given time period. Requires permission to access the ListAuditTasks action. */ listAuditTasks(input: AWS.Iot.ListAuditTasksRequest, options: SdkCallOptions): Promise; /** * Lists the authorizers registered in your account. Requires permission to access the ListAuthorizers action. */ listAuthorizers(input: AWS.Iot.ListAuthorizersRequest, options: SdkCallOptions): Promise; /** * Lists the billing groups you have created. Requires permission to access the ListBillingGroups action. */ listBillingGroups(input: AWS.Iot.ListBillingGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the CA certificates registered for your Amazon Web Services account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. Requires permission to access the ListCACertificates action. */ listCACertificates(input: AWS.Iot.ListCACertificatesRequest, options: SdkCallOptions): Promise; /** * Lists the certificates registered in your Amazon Web Services account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. Requires permission to access the ListCertificates action. */ listCertificates(input: AWS.Iot.ListCertificatesRequest, options: SdkCallOptions): Promise; /** * List the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action. */ listCertificatesByCA(input: AWS.Iot.ListCertificatesByCARequest, options: SdkCallOptions): Promise; /** * Lists your Device Defender detect custom metrics. Requires permission to access the ListCustomMetrics action. */ listCustomMetrics(input: AWS.Iot.ListCustomMetricsRequest, options: SdkCallOptions): Promise; /** * Lists mitigation actions executions for a Device Defender ML Detect Security Profile. Requires permission to access the ListDetectMitigationActionsExecutions action. */ listDetectMitigationActionsExecutions(input: AWS.Iot.ListDetectMitigationActionsExecutionsRequest, options: SdkCallOptions): Promise; /** * List of Device Defender ML Detect mitigation actions tasks. Requires permission to access the ListDetectMitigationActionsTasks action. */ listDetectMitigationActionsTasks(input: AWS.Iot.ListDetectMitigationActionsTasksRequest, options: SdkCallOptions): Promise; /** * List the set of dimensions that are defined for your Amazon Web Services accounts. Requires permission to access the ListDimensions action. */ listDimensions(input: AWS.Iot.ListDimensionsRequest, options: SdkCallOptions): Promise; /** * Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the ListDomainConfigurations action. */ listDomainConfigurations(input: AWS.Iot.ListDomainConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists all your fleet metrics. Requires permission to access the ListFleetMetrics action. */ listFleetMetrics(input: AWS.Iot.ListFleetMetricsRequest, options: SdkCallOptions): Promise; /** * Lists the search indices. Requires permission to access the ListIndices action. */ listIndices(input: AWS.Iot.ListIndicesRequest, options: SdkCallOptions): Promise; /** * Lists the job executions for a job. Requires permission to access the ListJobExecutionsForJob action. */ listJobExecutionsForJob(input: AWS.Iot.ListJobExecutionsForJobRequest, options: SdkCallOptions): Promise; /** * Lists the job executions for the specified thing. Requires permission to access the ListJobExecutionsForThing action. */ listJobExecutionsForThing(input: AWS.Iot.ListJobExecutionsForThingRequest, options: SdkCallOptions): Promise; /** * Returns a list of job templates. Requires permission to access the ListJobTemplates action. */ listJobTemplates(input: AWS.Iot.ListJobTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists jobs. Requires permission to access the ListJobs action. */ listJobs(input: AWS.Iot.ListJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of managed job templates. */ listManagedJobTemplates(input: AWS.Iot.ListManagedJobTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period. */ listMetricValues(input: AWS.Iot.ListMetricValuesRequest, options: SdkCallOptions): Promise; /** * Gets a list of all mitigation actions that match the specified filter criteria. Requires permission to access the ListMitigationActions action. */ listMitigationActions(input: AWS.Iot.ListMitigationActionsRequest, options: SdkCallOptions): Promise; /** * Lists OTA updates. Requires permission to access the ListOTAUpdates action. */ listOTAUpdates(input: AWS.Iot.ListOTAUpdatesRequest, options: SdkCallOptions): Promise; /** * Lists certificates that are being transferred but not yet accepted. Requires permission to access the ListOutgoingCertificates action. */ listOutgoingCertificates(input: AWS.Iot.ListOutgoingCertificatesRequest, options: SdkCallOptions): Promise; /** * Lists your policies. Requires permission to access the ListPolicies action. */ listPolicies(input: AWS.Iot.ListPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the principals associated with the specified policy. Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead. Requires permission to access the ListPolicyPrincipals action. */ listPolicyPrincipals(input: AWS.Iot.ListPolicyPrincipalsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of the specified policy and identifies the default version. Requires permission to access the ListPolicyVersions action. */ listPolicyVersions(input: AWS.Iot.ListPolicyVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead. Requires permission to access the ListPrincipalPolicies action. */ listPrincipalPolicies(input: AWS.Iot.ListPrincipalPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. Requires permission to access the ListPrincipalThings action. */ listPrincipalThings(input: AWS.Iot.ListPrincipalThingsRequest, options: SdkCallOptions): Promise; /** * A list of provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action. */ listProvisioningTemplateVersions(input: AWS.Iot.ListProvisioningTemplateVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the provisioning templates in your Amazon Web Services account. Requires permission to access the ListProvisioningTemplates action. */ listProvisioningTemplates(input: AWS.Iot.ListProvisioningTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists the role aliases registered in your account. Requires permission to access the ListRoleAliases action. */ listRoleAliases(input: AWS.Iot.ListRoleAliasesRequest, options: SdkCallOptions): Promise; /** * Lists all of your scheduled audits. Requires permission to access the ListScheduledAudits action. */ listScheduledAudits(input: AWS.Iot.ListScheduledAuditsRequest, options: SdkCallOptions): Promise; /** * Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. Requires permission to access the ListSecurityProfiles action. dimensionName and metricName cannot be used in the same request. */ listSecurityProfiles(input: AWS.Iot.ListSecurityProfilesRequest, options: SdkCallOptions): Promise; /** * Lists the Device Defender security profiles attached to a target (thing group). Requires permission to access the ListSecurityProfilesForTarget action. */ listSecurityProfilesForTarget(input: AWS.Iot.ListSecurityProfilesForTargetRequest, options: SdkCallOptions): Promise; /** * Lists all of the streams in your Amazon Web Services account. Requires permission to access the ListStreams action. */ listStreams(input: AWS.Iot.ListStreamsRequest, options: SdkCallOptions): Promise; /** * Lists the tags (metadata) you have assigned to the resource. Requires permission to access the ListTagsForResource action. */ listTagsForResource(input: AWS.Iot.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * List targets for the specified policy. Requires permission to access the ListTargetsForPolicy action. */ listTargetsForPolicy(input: AWS.Iot.ListTargetsForPolicyRequest, options: SdkCallOptions): Promise; /** * Lists the targets (thing groups) associated with a given Device Defender security profile. Requires permission to access the ListTargetsForSecurityProfile action. */ listTargetsForSecurityProfile(input: AWS.Iot.ListTargetsForSecurityProfileRequest, options: SdkCallOptions): Promise; /** * List the thing groups in your account. Requires permission to access the ListThingGroups action. */ listThingGroups(input: AWS.Iot.ListThingGroupsRequest, options: SdkCallOptions): Promise; /** * List the thing groups to which the specified thing belongs. Requires permission to access the ListThingGroupsForThing action. */ listThingGroupsForThing(input: AWS.Iot.ListThingGroupsForThingRequest, options: SdkCallOptions): Promise; /** * Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. Requires permission to access the ListThingPrincipals action. */ listThingPrincipals(input: AWS.Iot.ListThingPrincipalsRequest, options: SdkCallOptions): Promise; /** * Information about the thing registration tasks. */ listThingRegistrationTaskReports(input: AWS.Iot.ListThingRegistrationTaskReportsRequest, options: SdkCallOptions): Promise; /** * List bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action. */ listThingRegistrationTasks(input: AWS.Iot.ListThingRegistrationTasksRequest, options: SdkCallOptions): Promise; /** * Lists the existing thing types. Requires permission to access the ListThingTypes action. */ listThingTypes(input: AWS.Iot.ListThingTypesRequest, options: SdkCallOptions): Promise; /** * Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. Requires permission to access the ListThings action. You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned. */ listThings(input: AWS.Iot.ListThingsRequest, options: SdkCallOptions): Promise; /** * Lists the things you have added to the given billing group. Requires permission to access the ListThingsInBillingGroup action. */ listThingsInBillingGroup(input: AWS.Iot.ListThingsInBillingGroupRequest, options: SdkCallOptions): Promise; /** * Lists the things in the specified group. Requires permission to access the ListThingsInThingGroup action. */ listThingsInThingGroup(input: AWS.Iot.ListThingsInThingGroupRequest, options: SdkCallOptions): Promise; /** * Lists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action. */ listTopicRuleDestinations(input: AWS.Iot.ListTopicRuleDestinationsRequest, options: SdkCallOptions): Promise; /** * Lists the rules for the specific topic. Requires permission to access the ListTopicRules action. */ listTopicRules(input: AWS.Iot.ListTopicRulesRequest, options: SdkCallOptions): Promise; /** * Lists logging levels. Requires permission to access the ListV2LoggingLevels action. */ listV2LoggingLevels(input: AWS.Iot.ListV2LoggingLevelsRequest, options: SdkCallOptions): Promise; /** * Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device). Requires permission to access the ListViolationEvents action. */ listViolationEvents(input: AWS.Iot.ListViolationEventsRequest, options: SdkCallOptions): Promise; /** * Set a verification state and provide a description of that verification state on a violation (detect alarm). */ putVerificationStateOnViolation(input: AWS.Iot.PutVerificationStateOnViolationRequest, options: SdkCallOptions): Promise; /** * Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account. Requires permission to access the RegisterCACertificate action. */ registerCACertificate(input: AWS.Iot.RegisterCACertificateRequest, options: SdkCallOptions): Promise; /** * Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered. Requires permission to access the RegisterCertificate action. */ registerCertificate(input: AWS.Iot.RegisterCertificateRequest, options: SdkCallOptions): Promise; /** * Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT. */ registerCertificateWithoutCA(input: AWS.Iot.RegisterCertificateWithoutCARequest, options: SdkCallOptions): Promise; /** * Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary. Requires permission to access the RegisterThing action. */ registerThing(input: AWS.Iot.RegisterThingRequest, options: SdkCallOptions): Promise; /** * Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state. Requires permission to access the RejectCertificateTransfer action. */ rejectCertificateTransfer(input: AWS.Iot.RejectCertificateTransferRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the given thing from the billing group. Requires permission to access the RemoveThingFromBillingGroup action. This call is asynchronous. It might take several seconds for the detachment to propagate. */ removeThingFromBillingGroup(input: AWS.Iot.RemoveThingFromBillingGroupRequest, options: SdkCallOptions): Promise; /** * Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group. Requires permission to access the RemoveThingFromThingGroup action. */ removeThingFromThingGroup(input: AWS.Iot.RemoveThingFromThingGroupRequest, options: SdkCallOptions): Promise; /** * Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. Requires permission to access the ReplaceTopicRule action. */ replaceTopicRule(input: AWS.Iot.ReplaceTopicRuleRequest, options: SdkCallOptions): Promise<{}>; /** * The query search index. Requires permission to access the SearchIndex action. */ searchIndex(input: AWS.Iot.SearchIndexRequest, options: SdkCallOptions): Promise; /** * Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action. */ setDefaultAuthorizer(input: AWS.Iot.SetDefaultAuthorizerRequest, options: SdkCallOptions): Promise; /** * Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action. Requires permission to access the SetDefaultPolicyVersion action. */ setDefaultPolicyVersion(input: AWS.Iot.SetDefaultPolicyVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions action. */ setLoggingOptions(input: AWS.Iot.SetLoggingOptionsRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the logging level. Requires permission to access the SetV2LoggingLevel action. */ setV2LoggingLevel(input: AWS.Iot.SetV2LoggingLevelRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the logging options for the V2 logging service. Requires permission to access the SetV2LoggingOptions action. */ setV2LoggingOptions(input: AWS.Iot.SetV2LoggingOptionsRequest, options: SdkCallOptions): Promise<{}>; /** * Starts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action. */ startAuditMitigationActionsTask(input: AWS.Iot.StartAuditMitigationActionsTaskRequest, options: SdkCallOptions): Promise; /** * Starts a Device Defender ML Detect mitigation actions task. Requires permission to access the StartDetectMitigationActionsTask action. */ startDetectMitigationActionsTask(input: AWS.Iot.StartDetectMitigationActionsTaskRequest, options: SdkCallOptions): Promise; /** * Starts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action. */ startOnDemandAuditTask(input: AWS.Iot.StartOnDemandAuditTaskRequest, options: SdkCallOptions): Promise; /** * Creates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action. */ startThingRegistrationTask(input: AWS.Iot.StartThingRegistrationTaskRequest, options: SdkCallOptions): Promise; /** * Cancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action. */ stopThingRegistrationTask(input: AWS.Iot.StopThingRegistrationTaskRequest, options: SdkCallOptions): Promise; /** * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. Requires permission to access the TagResource action. */ tagResource(input: AWS.Iot.TagResourceRequest, options: SdkCallOptions): Promise; /** * Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestAuthorization action. */ testAuthorization(input: AWS.Iot.TestAuthorizationRequest, options: SdkCallOptions): Promise; /** * Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestInvokeAuthorizer action. */ testInvokeAuthorizer(input: AWS.Iot.TestInvokeAuthorizerRequest, options: SdkCallOptions): Promise; /** * Transfers the specified certificate to the specified Amazon Web Services account. Requires permission to access the TransferCertificate action. You can cancel the transfer until it is acknowledged by the recipient. No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them. */ transferCertificate(input: AWS.Iot.TransferCertificateRequest, options: SdkCallOptions): Promise; /** * Removes the given tags (metadata) from the resource. Requires permission to access the UntagResource action. */ untagResource(input: AWS.Iot.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the UpdateAccountAuditConfiguration action. */ updateAccountAuditConfiguration(input: AWS.Iot.UpdateAccountAuditConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates a Device Defender audit suppression. */ updateAuditSuppression(input: AWS.Iot.UpdateAuditSuppressionRequest, options: SdkCallOptions): Promise; /** * Updates an authorizer. Requires permission to access the UpdateAuthorizer action. */ updateAuthorizer(input: AWS.Iot.UpdateAuthorizerRequest, options: SdkCallOptions): Promise; /** * Updates information about the billing group. Requires permission to access the UpdateBillingGroup action. */ updateBillingGroup(input: AWS.Iot.UpdateBillingGroupRequest, options: SdkCallOptions): Promise; /** * Updates a registered CA certificate. Requires permission to access the UpdateCACertificate action. */ updateCACertificate(input: AWS.Iot.UpdateCACertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the status of the specified certificate. This operation is idempotent. Requires permission to access the UpdateCertificate action. Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT. Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect. */ updateCertificate(input: AWS.Iot.UpdateCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a Device Defender detect custom metric. Requires permission to access the UpdateCustomMetric action. */ updateCustomMetric(input: AWS.Iot.UpdateCustomMetricRequest, options: SdkCallOptions): Promise; /** * Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it). Requires permission to access the UpdateDimension action. */ updateDimension(input: AWS.Iot.UpdateDimensionRequest, options: SdkCallOptions): Promise; /** * Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action. */ updateDomainConfiguration(input: AWS.Iot.UpdateDomainConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action. */ updateDynamicThingGroup(input: AWS.Iot.UpdateDynamicThingGroupRequest, options: SdkCallOptions): Promise; /** * Updates the event configurations. Requires permission to access the UpdateEventConfigurations action. */ updateEventConfigurations(input: AWS.Iot.UpdateEventConfigurationsRequest, options: SdkCallOptions): Promise; /** * Updates the data for a fleet metric. Requires permission to access the UpdateFleetMetric action. */ updateFleetMetric(input: AWS.Iot.UpdateFleetMetricRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration action. */ updateIndexingConfiguration(input: AWS.Iot.UpdateIndexingConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates supported fields of the specified job. Requires permission to access the UpdateJob action. */ updateJob(input: AWS.Iot.UpdateJobRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action. */ updateMitigationAction(input: AWS.Iot.UpdateMitigationActionRequest, options: SdkCallOptions): Promise; /** * Updates a provisioning template. Requires permission to access the UpdateProvisioningTemplate action. */ updateProvisioningTemplate(input: AWS.Iot.UpdateProvisioningTemplateRequest, options: SdkCallOptions): Promise; /** * Updates a role alias. Requires permission to access the UpdateRoleAlias action. */ updateRoleAlias(input: AWS.Iot.UpdateRoleAliasRequest, options: SdkCallOptions): Promise; /** * Updates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit action. */ updateScheduledAudit(input: AWS.Iot.UpdateScheduledAuditRequest, options: SdkCallOptions): Promise; /** * Updates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action. */ updateSecurityProfile(input: AWS.Iot.UpdateSecurityProfileRequest, options: SdkCallOptions): Promise; /** * Updates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action. */ updateStream(input: AWS.Iot.UpdateStreamRequest, options: SdkCallOptions): Promise; /** * Updates the data for a thing. Requires permission to access the UpdateThing action. */ updateThing(input: AWS.Iot.UpdateThingRequest, options: SdkCallOptions): Promise; /** * Update a thing group. Requires permission to access the UpdateThingGroup action. */ updateThingGroup(input: AWS.Iot.UpdateThingGroupRequest, options: SdkCallOptions): Promise; /** * Updates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action. */ updateThingGroupsForThing(input: AWS.Iot.UpdateThingGroupsForThingRequest, options: SdkCallOptions): Promise; /** * Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the UpdateTopicRuleDestination action. */ updateTopicRuleDestination(input: AWS.Iot.UpdateTopicRuleDestinationRequest, options: SdkCallOptions): Promise; /** * Validates a Device Defender security profile behaviors specification. Requires permission to access the ValidateSecurityProfileBehaviors action. */ validateSecurityProfileBehaviors(input: AWS.Iot.ValidateSecurityProfileBehaviorsRequest, options: SdkCallOptions): Promise; } export interface IoT1ClickDevicesService { /** * Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s). */ claimDevicesByClaimCode(input: AWS.IoT1ClickDevicesService.ClaimDevicesByClaimCodeRequest, options: SdkCallOptions): Promise; /** * Given a device ID, returns a DescribeDeviceResponse object describing the details of the device. */ describeDevice(input: AWS.IoT1ClickDevicesService.DescribeDeviceRequest, options: SdkCallOptions): Promise; /** * Given a device ID, finalizes the claim request for the associated device. Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device. */ finalizeDeviceClaim(input: AWS.IoT1ClickDevicesService.FinalizeDeviceClaimRequest, options: SdkCallOptions): Promise; /** * Given a device ID, returns the invokable methods associated with the device. */ getDeviceMethods(input: AWS.IoT1ClickDevicesService.GetDeviceMethodsRequest, options: SdkCallOptions): Promise; /** * Given a device ID, initiates a claim request for the associated device. Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device. */ initiateDeviceClaim(input: AWS.IoT1ClickDevicesService.InitiateDeviceClaimRequest, options: SdkCallOptions): Promise; /** * Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below. */ invokeDeviceMethod(input: AWS.IoT1ClickDevicesService.InvokeDeviceMethodRequest, options: SdkCallOptions): Promise; /** * Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device. */ listDeviceEvents(input: AWS.IoT1ClickDevicesService.ListDeviceEventsRequest, options: SdkCallOptions): Promise; /** * Lists the 1-Click compatible devices associated with your AWS account. */ listDevices(input: AWS.IoT1ClickDevicesService.ListDevicesRequest, options: SdkCallOptions): Promise; /** * Lists the tags associated with the specified resource ARN. */ listTagsForResource(input: AWS.IoT1ClickDevicesService.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource. */ tagResource(input: AWS.IoT1ClickDevicesService.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates a device from your AWS account using its device ID. */ unclaimDevice(input: AWS.IoT1ClickDevicesService.UnclaimDeviceRequest, options: SdkCallOptions): Promise; /** * Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN. */ untagResource(input: AWS.IoT1ClickDevicesService.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Using a Boolean value (true or false), this operation enables or disables the device given a device ID. */ updateDeviceState(input: AWS.IoT1ClickDevicesService.UpdateDeviceStateRequest, options: SdkCallOptions): Promise; } export interface IoT1ClickProjects { /** * Associates a physical device with a placement. */ associateDeviceWithPlacement(input: AWS.IoT1ClickProjects.AssociateDeviceWithPlacementRequest, options: SdkCallOptions): Promise; /** * Creates an empty placement. */ createPlacement(input: AWS.IoT1ClickProjects.CreatePlacementRequest, options: SdkCallOptions): Promise; /** * Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. */ createProject(input: AWS.IoT1ClickProjects.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Deletes a placement. To delete a placement, it must not have any devices associated with it. When you delete a placement, all associated data becomes irretrievable. */ deletePlacement(input: AWS.IoT1ClickProjects.DeletePlacementRequest, options: SdkCallOptions): Promise; /** * Deletes a project. To delete a project, it must not have any placements associated with it. When you delete a project, all associated data becomes irretrievable. */ deleteProject(input: AWS.IoT1ClickProjects.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Describes a placement in a project. */ describePlacement(input: AWS.IoT1ClickProjects.DescribePlacementRequest, options: SdkCallOptions): Promise; /** * Returns an object describing a project. */ describeProject(input: AWS.IoT1ClickProjects.DescribeProjectRequest, options: SdkCallOptions): Promise; /** * Removes a physical device from a placement. */ disassociateDeviceFromPlacement(input: AWS.IoT1ClickProjects.DisassociateDeviceFromPlacementRequest, options: SdkCallOptions): Promise; /** * Returns an object enumerating the devices in a placement. */ getDevicesInPlacement(input: AWS.IoT1ClickProjects.GetDevicesInPlacementRequest, options: SdkCallOptions): Promise; /** * Lists the placement(s) of a project. */ listPlacements(input: AWS.IoT1ClickProjects.ListPlacementsRequest, options: SdkCallOptions): Promise; /** * Lists the AWS IoT 1-Click project(s) associated with your AWS account and region. */ listProjects(input: AWS.IoT1ClickProjects.ListProjectsRequest, options: SdkCallOptions): Promise; /** * Lists the tags (metadata key/value pairs) which you have assigned to the resource. */ listTagsForResource(input: AWS.IoT1ClickProjects.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies. */ tagResource(input: AWS.IoT1ClickProjects.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags (metadata key/value pairs) from a resource. */ untagResource(input: AWS.IoT1ClickProjects.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., ""). */ updatePlacement(input: AWS.IoT1ClickProjects.UpdatePlacementRequest, options: SdkCallOptions): Promise; /** * Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., ""). */ updateProject(input: AWS.IoT1ClickProjects.UpdateProjectRequest, options: SdkCallOptions): Promise; } export interface IoTAnalytics { /** * Sends messages to a channel. */ batchPutMessage(input: AWS.IoTAnalytics.BatchPutMessageRequest, options: SdkCallOptions): Promise; /** * Cancels the reprocessing of data through the pipeline. */ cancelPipelineReprocessing(input: AWS.IoTAnalytics.CancelPipelineReprocessingRequest, options: SdkCallOptions): Promise; /** * Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. */ createChannel(input: AWS.IoTAnalytics.CreateChannelRequest, options: SdkCallOptions): Promise; /** * Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify. */ createDataset(input: AWS.IoTAnalytics.CreateDatasetRequest, options: SdkCallOptions): Promise; /** * Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). */ createDatasetContent(input: AWS.IoTAnalytics.CreateDatasetContentRequest, options: SdkCallOptions): Promise; /** * Creates a data store, which is a repository for messages. */ createDatastore(input: AWS.IoTAnalytics.CreateDatastoreRequest, options: SdkCallOptions): Promise; /** * Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. */ createPipeline(input: AWS.IoTAnalytics.CreatePipelineRequest, options: SdkCallOptions): Promise; /** * Deletes the specified channel. */ deleteChannel(input: AWS.IoTAnalytics.DeleteChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified dataset. You do not have to delete the content of the dataset before you perform this operation. */ deleteDataset(input: AWS.IoTAnalytics.DeleteDatasetRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the content of the specified dataset. */ deleteDatasetContent(input: AWS.IoTAnalytics.DeleteDatasetContentRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified data store. */ deleteDatastore(input: AWS.IoTAnalytics.DeleteDatastoreRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified pipeline. */ deletePipeline(input: AWS.IoTAnalytics.DeletePipelineRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves information about a channel. */ describeChannel(input: AWS.IoTAnalytics.DescribeChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a dataset. */ describeDataset(input: AWS.IoTAnalytics.DescribeDatasetRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a data store. */ describeDatastore(input: AWS.IoTAnalytics.DescribeDatastoreRequest, options: SdkCallOptions): Promise; /** * Retrieves the current settings of the IoT Analytics logging options. */ describeLoggingOptions(input: AWS.IoTAnalytics.DescribeLoggingOptionsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a pipeline. */ describePipeline(input: AWS.IoTAnalytics.DescribePipelineRequest, options: SdkCallOptions): Promise; /** * Retrieves the contents of a dataset as presigned URIs. */ getDatasetContent(input: AWS.IoTAnalytics.GetDatasetContentRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of channels. */ listChannels(input: AWS.IoTAnalytics.ListChannelsRequest, options: SdkCallOptions): Promise; /** * Lists information about dataset contents that have been created. */ listDatasetContents(input: AWS.IoTAnalytics.ListDatasetContentsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about datasets. */ listDatasets(input: AWS.IoTAnalytics.ListDatasetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of data stores. */ listDatastores(input: AWS.IoTAnalytics.ListDatastoresRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of pipelines. */ listPipelines(input: AWS.IoTAnalytics.ListPipelinesRequest, options: SdkCallOptions): Promise; /** * Lists the tags (metadata) that you have assigned to the resource. */ listTagsForResource(input: AWS.IoTAnalytics.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Sets or updates the IoT Analytics logging options. If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect. */ putLoggingOptions(input: AWS.IoTAnalytics.PutLoggingOptionsRequest, options: SdkCallOptions): Promise<{}>; /** * Simulates the results of running a pipeline activity on a message payload. */ runPipelineActivity(input: AWS.IoTAnalytics.RunPipelineActivityRequest, options: SdkCallOptions): Promise; /** * Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved. */ sampleChannelData(input: AWS.IoTAnalytics.SampleChannelDataRequest, options: SdkCallOptions): Promise; /** * Starts the reprocessing of raw message data through the pipeline. */ startPipelineReprocessing(input: AWS.IoTAnalytics.StartPipelineReprocessingRequest, options: SdkCallOptions): Promise; /** * Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. */ tagResource(input: AWS.IoTAnalytics.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the given tags (metadata) from the resource. */ untagResource(input: AWS.IoTAnalytics.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Used to update the settings of a channel. */ updateChannel(input: AWS.IoTAnalytics.UpdateChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the settings of a dataset. */ updateDataset(input: AWS.IoTAnalytics.UpdateDatasetRequest, options: SdkCallOptions): Promise<{}>; /** * Used to update the settings of a data store. */ updateDatastore(input: AWS.IoTAnalytics.UpdateDatastoreRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. */ updatePipeline(input: AWS.IoTAnalytics.UpdatePipelineRequest, options: SdkCallOptions): Promise<{}>; } export interface IotData { /** * Deletes the shadow for the specified thing. Requires permission to access the DeleteThingShadow action. For more information, see DeleteThingShadow in the IoT Developer Guide. */ deleteThingShadow(input: AWS.IotData.DeleteThingShadowRequest, options: SdkCallOptions): Promise; /** * Gets the details of a single retained message for the specified topic. This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages. Requires permission to access the GetRetainedMessage action. For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging. */ getRetainedMessage(input: AWS.IotData.GetRetainedMessageRequest, options: SdkCallOptions): Promise; /** * Gets the shadow for the specified thing. Requires permission to access the GetThingShadow action. For more information, see GetThingShadow in the IoT Developer Guide. */ getThingShadow(input: AWS.IotData.GetThingShadowRequest, options: SdkCallOptions): Promise; /** * Lists the shadows for the specified thing. Requires permission to access the ListNamedShadowsForThing action. */ listNamedShadowsForThing(input: AWS.IotData.ListNamedShadowsForThingRequest, options: SdkCallOptions): Promise; /** * Lists summary information about the retained messages stored for the account. This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs. To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message. Requires permission to access the ListRetainedMessages action. For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging. */ listRetainedMessages(input: AWS.IotData.ListRetainedMessagesRequest, options: SdkCallOptions): Promise; /** * Publishes an MQTT message. Requires permission to access the Publish action. For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide. For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging. */ publish(input: AWS.IotData.PublishRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the shadow for the specified thing. Requires permission to access the UpdateThingShadow action. For more information, see UpdateThingShadow in the IoT Developer Guide. */ updateThingShadow(input: AWS.IotData.UpdateThingShadowRequest, options: SdkCallOptions): Promise; } export interface IotDeviceAdvisor { /** * Creates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action. */ createSuiteDefinition(input: AWS.IotDeviceAdvisor.CreateSuiteDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action. */ deleteSuiteDefinition(input: AWS.IotDeviceAdvisor.DeleteSuiteDefinitionRequest, options: SdkCallOptions): Promise; /** * Gets information about an Device Advisor endpoint. */ getEndpoint(input: AWS.IotDeviceAdvisor.GetEndpointRequest, options: SdkCallOptions): Promise; /** * Gets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition action. */ getSuiteDefinition(input: AWS.IotDeviceAdvisor.GetSuiteDefinitionRequest, options: SdkCallOptions): Promise; /** * Gets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action. */ getSuiteRun(input: AWS.IotDeviceAdvisor.GetSuiteRunRequest, options: SdkCallOptions): Promise; /** * Gets a report download link for a successful Device Advisor qualifying test suite run. Requires permission to access the GetSuiteRunReport action. */ getSuiteRunReport(input: AWS.IotDeviceAdvisor.GetSuiteRunReportRequest, options: SdkCallOptions): Promise; /** * Lists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action. */ listSuiteDefinitions(input: AWS.IotDeviceAdvisor.ListSuiteDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite. Requires permission to access the ListSuiteRuns action. */ listSuiteRuns(input: AWS.IotDeviceAdvisor.ListSuiteRunsRequest, options: SdkCallOptions): Promise; /** * Lists the tags attached to an IoT Device Advisor resource. Requires permission to access the ListTagsForResource action. */ listTagsForResource(input: AWS.IotDeviceAdvisor.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action. */ startSuiteRun(input: AWS.IotDeviceAdvisor.StartSuiteRunRequest, options: SdkCallOptions): Promise; /** * Stops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action. */ stopSuiteRun(input: AWS.IotDeviceAdvisor.StopSuiteRunRequest, options: SdkCallOptions): Promise; /** * Adds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the TagResource action. */ tagResource(input: AWS.IotDeviceAdvisor.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action. */ untagResource(input: AWS.IotDeviceAdvisor.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action. */ updateSuiteDefinition(input: AWS.IotDeviceAdvisor.UpdateSuiteDefinitionRequest, options: SdkCallOptions): Promise; } export interface IoTEvents { /** * Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide. */ createAlarmModel(input: AWS.IoTEvents.CreateAlarmModelRequest, options: SdkCallOptions): Promise; /** * Creates a detector model. */ createDetectorModel(input: AWS.IoTEvents.CreateDetectorModelRequest, options: SdkCallOptions): Promise; /** * Creates an input. */ createInput(input: AWS.IoTEvents.CreateInputRequest, options: SdkCallOptions): Promise; /** * Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone. */ deleteAlarmModel(input: AWS.IoTEvents.DeleteAlarmModelRequest, options: SdkCallOptions): Promise; /** * Deletes a detector model. Any active instances of the detector model are also deleted. */ deleteDetectorModel(input: AWS.IoTEvents.DeleteDetectorModelRequest, options: SdkCallOptions): Promise; /** * Deletes an input. */ deleteInput(input: AWS.IoTEvents.DeleteInputRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned. */ describeAlarmModel(input: AWS.IoTEvents.DescribeAlarmModelRequest, options: SdkCallOptions): Promise; /** * Describes a detector model. If the version parameter is not specified, information about the latest version is returned. */ describeDetectorModel(input: AWS.IoTEvents.DescribeDetectorModelRequest, options: SdkCallOptions): Promise; /** * Retrieves runtime information about a detector model analysis. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results. */ describeDetectorModelAnalysis(input: AWS.IoTEvents.DescribeDetectorModelAnalysisRequest, options: SdkCallOptions): Promise; /** * Describes an input. */ describeInput(input: AWS.IoTEvents.DescribeInputRequest, options: SdkCallOptions): Promise; /** * Retrieves the current settings of the AWS IoT Events logging options. */ describeLoggingOptions(input: AWS.IoTEvents.DescribeLoggingOptionsRequest, options: SdkCallOptions): Promise; /** * Retrieves one or more analysis results of the detector model. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results. */ getDetectorModelAnalysisResults(input: AWS.IoTEvents.GetDetectorModelAnalysisResultsRequest, options: SdkCallOptions): Promise; /** * Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version. */ listAlarmModelVersions(input: AWS.IoTEvents.ListAlarmModelVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model. */ listAlarmModels(input: AWS.IoTEvents.ListAlarmModelsRequest, options: SdkCallOptions): Promise; /** * Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. */ listDetectorModelVersions(input: AWS.IoTEvents.ListDetectorModelVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the detector models you have created. Only the metadata associated with each detector model is returned. */ listDetectorModels(input: AWS.IoTEvents.ListDetectorModelsRequest, options: SdkCallOptions): Promise; /** * Lists one or more input routings. */ listInputRoutings(input: AWS.IoTEvents.ListInputRoutingsRequest, options: SdkCallOptions): Promise; /** * Lists the inputs you have created. */ listInputs(input: AWS.IoTEvents.ListInputsRequest, options: SdkCallOptions): Promise; /** * Lists the tags (metadata) you have assigned to the resource. */ listTagsForResource(input: AWS.IoTEvents.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Sets or updates the AWS IoT Events logging options. If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect. */ putLoggingOptions(input: AWS.IoTEvents.PutLoggingOptionsRequest, options: SdkCallOptions): Promise<{}>; /** * Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide. */ startDetectorModelAnalysis(input: AWS.IoTEvents.StartDetectorModelAnalysisRequest, options: SdkCallOptions): Promise; /** * Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. */ tagResource(input: AWS.IoTEvents.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the given tags (metadata) from the resource. */ untagResource(input: AWS.IoTEvents.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives. */ updateAlarmModel(input: AWS.IoTEvents.UpdateAlarmModelRequest, options: SdkCallOptions): Promise; /** * Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. */ updateDetectorModel(input: AWS.IoTEvents.UpdateDetectorModelRequest, options: SdkCallOptions): Promise; /** * Updates an input. */ updateInput(input: AWS.IoTEvents.UpdateInputRequest, options: SdkCallOptions): Promise; } export interface IoTEventsData { /** * Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them. */ batchAcknowledgeAlarm(input: AWS.IoTEventsData.BatchAcknowledgeAlarmRequest, options: SdkCallOptions): Promise; /** * Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call. */ batchDeleteDetector(input: AWS.IoTEventsData.BatchDeleteDetectorRequest, options: SdkCallOptions): Promise; /** * Disables one or more alarms. The alarms change to the DISABLED state after you disable them. */ batchDisableAlarm(input: AWS.IoTEventsData.BatchDisableAlarmRequest, options: SdkCallOptions): Promise; /** * Enables one or more alarms. The alarms change to the NORMAL state after you enable them. */ batchEnableAlarm(input: AWS.IoTEventsData.BatchEnableAlarmRequest, options: SdkCallOptions): Promise; /** * Sends a set of messages to the IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. */ batchPutMessage(input: AWS.IoTEventsData.BatchPutMessageRequest, options: SdkCallOptions): Promise; /** * Resets one or more alarms. The alarms return to the NORMAL state after you reset them. */ batchResetAlarm(input: AWS.IoTEventsData.BatchResetAlarmRequest, options: SdkCallOptions): Promise; /** * Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode. */ batchSnoozeAlarm(input: AWS.IoTEventsData.BatchSnoozeAlarmRequest, options: SdkCallOptions): Promise; /** * Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. */ batchUpdateDetector(input: AWS.IoTEventsData.BatchUpdateDetectorRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an alarm. */ describeAlarm(input: AWS.IoTEventsData.DescribeAlarmRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified detector (instance). */ describeDetector(input: AWS.IoTEventsData.DescribeDetectorRequest, options: SdkCallOptions): Promise; /** * Lists one or more alarms. The operation returns only the metadata associated with each alarm. */ listAlarms(input: AWS.IoTEventsData.ListAlarmsRequest, options: SdkCallOptions): Promise; /** * Lists detectors (the instances of a detector model). */ listDetectors(input: AWS.IoTEventsData.ListDetectorsRequest, options: SdkCallOptions): Promise; } export interface IoTFleetHub { /** * Creates a Fleet Hub for AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. */ createApplication(input: AWS.IoTFleetHub.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes a Fleet Hub for AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. */ deleteApplication(input: AWS.IoTFleetHub.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * Gets information about a Fleet Hub for AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. */ describeApplication(input: AWS.IoTFleetHub.DescribeApplicationRequest, options: SdkCallOptions): Promise; /** * Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. */ listApplications(input: AWS.IoTFleetHub.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. */ listTagsForResource(input: AWS.IoTFleetHub.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. */ tagResource(input: AWS.IoTFleetHub.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags (metadata) from the resource. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. */ untagResource(input: AWS.IoTFleetHub.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates information about a Fleet Hub for a AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. */ updateApplication(input: AWS.IoTFleetHub.UpdateApplicationRequest, options: SdkCallOptions): Promise; } export interface IoTFleetWise { /** * Adds, or associates, a vehicle with a fleet. */ associateVehicleFleet(input: AWS.IoTFleetWise.AssociateVehicleFleetRequest, options: SdkCallOptions): Promise; /** * Creates a group, or batch, of vehicles. You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide. */ batchCreateVehicle(input: AWS.IoTFleetWise.BatchCreateVehicleRequest, options: SdkCallOptions): Promise; /** * Updates a group, or batch, of vehicles. You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide. */ batchUpdateVehicle(input: AWS.IoTFleetWise.BatchUpdateVehicleRequest, options: SdkCallOptions): Promise; /** * Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles. For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide. */ createCampaign(input: AWS.IoTFleetWise.CreateCampaignRequest, options: SdkCallOptions): Promise; /** * Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true: Every signal decoder has a unique name. Each signal decoder is associated with a network interface. Each network interface has a unique ID. The signal decoders are specified in the model manifest. */ createDecoderManifest(input: AWS.IoTFleetWise.CreateDecoderManifestRequest, options: SdkCallOptions): Promise; /** * Creates a fleet that represents a group of vehicles. You must create both a signal catalog and vehicles before you can create a fleet. For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide. */ createFleet(input: AWS.IoTFleetWise.CreateFleetRequest, options: SdkCallOptions): Promise; /** * Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide. */ createModelManifest(input: AWS.IoTFleetWise.CreateModelManifestRequest, options: SdkCallOptions): Promise; /** * Creates a collection of standardized signals that can be reused to create vehicle models. */ createSignalCatalog(input: AWS.IoTFleetWise.CreateSignalCatalogRequest, options: SdkCallOptions): Promise; /** * Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model. If you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing. For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide. */ createVehicle(input: AWS.IoTFleetWise.CreateVehicleRequest, options: SdkCallOptions): Promise; /** * Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles. */ deleteCampaign(input: AWS.IoTFleetWise.DeleteCampaignRequest, options: SdkCallOptions): Promise; /** * Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it. If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. */ deleteDecoderManifest(input: AWS.IoTFleetWise.DeleteDecoderManifestRequest, options: SdkCallOptions): Promise; /** * Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide. If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. */ deleteFleet(input: AWS.IoTFleetWise.DeleteFleetRequest, options: SdkCallOptions): Promise; /** * Deletes a vehicle model (model manifest). If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. */ deleteModelManifest(input: AWS.IoTFleetWise.DeleteModelManifestRequest, options: SdkCallOptions): Promise; /** * Deletes a signal catalog. If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. */ deleteSignalCatalog(input: AWS.IoTFleetWise.DeleteSignalCatalogRequest, options: SdkCallOptions): Promise; /** * Deletes a vehicle and removes it from any campaigns. If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. */ deleteVehicle(input: AWS.IoTFleetWise.DeleteVehicleRequest, options: SdkCallOptions): Promise; /** * Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle. If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. */ disassociateVehicleFleet(input: AWS.IoTFleetWise.DisassociateVehicleFleetRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a campaign. */ getCampaign(input: AWS.IoTFleetWise.GetCampaignRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a created decoder manifest. */ getDecoderManifest(input: AWS.IoTFleetWise.GetDecoderManifestRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a fleet. */ getFleet(input: AWS.IoTFleetWise.GetFleetRequest, options: SdkCallOptions): Promise; /** * Retrieves the logging options. */ getLoggingOptions(input: AWS.IoTFleetWise.GetLoggingOptionsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a vehicle model (model manifest). */ getModelManifest(input: AWS.IoTFleetWise.GetModelManifestRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise. This API operation doesn't require input parameters. */ getRegisterAccountStatus(input: AWS.IoTFleetWise.GetRegisterAccountStatusRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a signal catalog. */ getSignalCatalog(input: AWS.IoTFleetWise.GetSignalCatalogRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a vehicle. */ getVehicle(input: AWS.IoTFleetWise.GetVehicleRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status of a vehicle with any associated campaigns. */ getVehicleStatus(input: AWS.IoTFleetWise.GetVehicleStatusRequest, options: SdkCallOptions): Promise; /** * Creates a decoder manifest using your existing CAN DBC file from your local device. */ importDecoderManifest(input: AWS.IoTFleetWise.ImportDecoderManifestRequest, options: SdkCallOptions): Promise; /** * Creates a signal catalog using your existing VSS formatted content from your local device. */ importSignalCatalog(input: AWS.IoTFleetWise.ImportSignalCatalogRequest, options: SdkCallOptions): Promise; /** * Lists information about created campaigns. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listCampaigns(input: AWS.IoTFleetWise.ListCampaignsRequest, options: SdkCallOptions): Promise; /** * Lists the network interfaces specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listDecoderManifestNetworkInterfaces(input: AWS.IoTFleetWise.ListDecoderManifestNetworkInterfacesRequest, options: SdkCallOptions): Promise; /** * A list of information about signal decoders specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listDecoderManifestSignals(input: AWS.IoTFleetWise.ListDecoderManifestSignalsRequest, options: SdkCallOptions): Promise; /** * Lists decoder manifests. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listDecoderManifests(input: AWS.IoTFleetWise.ListDecoderManifestsRequest, options: SdkCallOptions): Promise; /** * Retrieves information for each created fleet in an Amazon Web Services account. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listFleets(input: AWS.IoTFleetWise.ListFleetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of IDs for all fleets that the vehicle is associated with. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listFleetsForVehicle(input: AWS.IoTFleetWise.ListFleetsForVehicleRequest, options: SdkCallOptions): Promise; /** * Lists information about nodes specified in a vehicle model (model manifest). This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listModelManifestNodes(input: AWS.IoTFleetWise.ListModelManifestNodesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of vehicle models (model manifests). This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listModelManifests(input: AWS.IoTFleetWise.ListModelManifestsRequest, options: SdkCallOptions): Promise; /** * Lists of information about the signals (nodes) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listSignalCatalogNodes(input: AWS.IoTFleetWise.ListSignalCatalogNodesRequest, options: SdkCallOptions): Promise; /** * Lists all the created signal catalogs in an Amazon Web Services account. You can use to list information about each signal (node) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listSignalCatalogs(input: AWS.IoTFleetWise.ListSignalCatalogsRequest, options: SdkCallOptions): Promise; /** * Lists the tags (metadata) you have assigned to the resource. */ listTagsForResource(input: AWS.IoTFleetWise.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of summaries of created vehicles. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listVehicles(input: AWS.IoTFleetWise.ListVehiclesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of summaries of all vehicles associated with a fleet. This API operation uses pagination. Specify the nextToken parameter in the request to return more results. */ listVehiclesInFleet(input: AWS.IoTFleetWise.ListVehiclesInFleetRequest, options: SdkCallOptions): Promise; /** * Creates or updates the logging option. */ putLoggingOptions(input: AWS.IoTFleetWise.PutLoggingOptionsRequest, options: SdkCallOptions): Promise; /** * Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise. An Amazon Web Services account is not the same thing as a "user account". An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles. */ registerAccount(input: AWS.IoTFleetWise.RegisterAccountRequest, options: SdkCallOptions): Promise; /** * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. */ tagResource(input: AWS.IoTFleetWise.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the given tags (metadata) from the resource. */ untagResource(input: AWS.IoTFleetWise.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a campaign. */ updateCampaign(input: AWS.IoTFleetWise.UpdateCampaignRequest, options: SdkCallOptions): Promise; /** * Updates a decoder manifest. A decoder manifest can only be updated when the status is DRAFT. Only ACTIVE decoder manifests can be associated with vehicles. */ updateDecoderManifest(input: AWS.IoTFleetWise.UpdateDecoderManifestRequest, options: SdkCallOptions): Promise; /** * Updates the description of an existing fleet. If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body. */ updateFleet(input: AWS.IoTFleetWise.UpdateFleetRequest, options: SdkCallOptions): Promise; /** * Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated. */ updateModelManifest(input: AWS.IoTFleetWise.UpdateModelManifestRequest, options: SdkCallOptions): Promise; /** * Updates a signal catalog. */ updateSignalCatalog(input: AWS.IoTFleetWise.UpdateSignalCatalogRequest, options: SdkCallOptions): Promise; /** * Updates a vehicle. */ updateVehicle(input: AWS.IoTFleetWise.UpdateVehicleRequest, options: SdkCallOptions): Promise; } export interface IoTJobsDataPlane { /** * Gets details of a job execution. */ describeJobExecution(input: AWS.IoTJobsDataPlane.DescribeJobExecutionRequest, options: SdkCallOptions): Promise; /** * Gets the list of all jobs for a thing that are not in a terminal status. */ getPendingJobExecutions(input: AWS.IoTJobsDataPlane.GetPendingJobExecutionsRequest, options: SdkCallOptions): Promise; /** * Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing. */ startNextPendingJobExecution(input: AWS.IoTJobsDataPlane.StartNextPendingJobExecutionRequest, options: SdkCallOptions): Promise; /** * Updates the status of a job execution. */ updateJobExecution(input: AWS.IoTJobsDataPlane.UpdateJobExecutionRequest, options: SdkCallOptions): Promise; } export interface IoTSecureTunneling { /** * Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted. Requires permission to access the CloseTunnel action. */ closeTunnel(input: AWS.IoTSecureTunneling.CloseTunnelRequest, options: SdkCallOptions): Promise; /** * Gets information about a tunnel identified by the unique tunnel id. Requires permission to access the DescribeTunnel action. */ describeTunnel(input: AWS.IoTSecureTunneling.DescribeTunnelRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.IoTSecureTunneling.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels. Requires permission to access the ListTunnels action. */ listTunnels(input: AWS.IoTSecureTunneling.ListTunnelsRequest, options: SdkCallOptions): Promise; /** * Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server. Requires permission to access the OpenTunnel action. */ openTunnel(input: AWS.IoTSecureTunneling.OpenTunnelRequest, options: SdkCallOptions): Promise; /** * Revokes the current client access token (CAT) and returns new CAT for clients to use when reconnecting to secure tunneling to access the same tunnel. Requires permission to access the RotateTunnelAccessToken action. Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel duration is 12 hours and the tunnel has already been open for 4 hours. When you rotate the access tokens, the new tokens that are generated can only be used for the remaining 8 hours. */ rotateTunnelAccessToken(input: AWS.IoTSecureTunneling.RotateTunnelAccessTokenRequest, options: SdkCallOptions): Promise; /** * A resource tag. */ tagResource(input: AWS.IoTSecureTunneling.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from a resource. */ untagResource(input: AWS.IoTSecureTunneling.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface IoTSiteWise { /** * Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide. */ associateAssets(input: AWS.IoTSiteWise.AssociateAssetsRequest, options: SdkCallOptions): Promise<{}>; /** * Associates a time series (data stream) with an asset property. */ associateTimeSeriesToAssetProperty(input: AWS.IoTSiteWise.AssociateTimeSeriesToAssetPropertyRequest, options: SdkCallOptions): Promise<{}>; /** * Associates a group (batch) of assets with an IoT SiteWise Monitor project. */ batchAssociateProjectAssets(input: AWS.IoTSiteWise.BatchAssociateProjectAssetsRequest, options: SdkCallOptions): Promise; /** * Disassociates a group (batch) of assets from an IoT SiteWise Monitor project. */ batchDisassociateProjectAssets(input: AWS.IoTSiteWise.BatchDisassociateProjectAssetsRequest, options: SdkCallOptions): Promise; /** * Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide. */ batchGetAssetPropertyAggregates(input: AWS.IoTSiteWise.BatchGetAssetPropertyAggregatesRequest, options: SdkCallOptions): Promise; /** * Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide. */ batchGetAssetPropertyValue(input: AWS.IoTSiteWise.BatchGetAssetPropertyValueRequest, options: SdkCallOptions): Promise; /** * Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide. */ batchGetAssetPropertyValueHistory(input: AWS.IoTSiteWise.BatchGetAssetPropertyValueHistoryRequest, options: SdkCallOptions): Promise; /** * Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error. For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV. IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide. */ batchPutAssetPropertyValue(input: AWS.IoTSiteWise.BatchPutAssetPropertyValueRequest, options: SdkCallOptions): Promise; /** * Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. */ createAccessPolicy(input: AWS.IoTSiteWise.CreateAccessPolicyRequest, options: SdkCallOptions): Promise; /** * Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide. */ createAsset(input: AWS.IoTSiteWise.CreateAssetRequest, options: SdkCallOptions): Promise; /** * Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide. */ createAssetModel(input: AWS.IoTSiteWise.CreateAssetModelRequest, options: SdkCallOptions): Promise; /** * Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration. */ createBulkImportJob(input: AWS.IoTSiteWise.CreateBulkImportJobRequest, options: SdkCallOptions): Promise; /** * Creates a dashboard in an IoT SiteWise Monitor project. */ createDashboard(input: AWS.IoTSiteWise.CreateDashboardRequest, options: SdkCallOptions): Promise; /** * Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide. */ createGateway(input: AWS.IoTSiteWise.CreateGatewayRequest, options: SdkCallOptions): Promise; /** * Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide. */ createPortal(input: AWS.IoTSiteWise.CreatePortalRequest, options: SdkCallOptions): Promise; /** * Creates a project in the specified portal. Make sure that the project name and description don't contain confidential information. */ createProject(input: AWS.IoTSiteWise.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource. */ deleteAccessPolicy(input: AWS.IoTSiteWise.DeleteAccessPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets. */ deleteAsset(input: AWS.IoTSiteWise.DeleteAssetRequest, options: SdkCallOptions): Promise; /** * Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide. */ deleteAssetModel(input: AWS.IoTSiteWise.DeleteAssetModelRequest, options: SdkCallOptions): Promise; /** * Deletes a dashboard from IoT SiteWise Monitor. */ deleteDashboard(input: AWS.IoTSiteWise.DeleteDashboardRequest, options: SdkCallOptions): Promise; /** * Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system. */ deleteGateway(input: AWS.IoTSiteWise.DeleteGatewayRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a portal from IoT SiteWise Monitor. */ deletePortal(input: AWS.IoTSiteWise.DeletePortalRequest, options: SdkCallOptions): Promise; /** * Deletes a project from IoT SiteWise Monitor. */ deleteProject(input: AWS.IoTSiteWise.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property. To identify a time series, do one of the following: If the time series isn't associated with an asset property, specify the alias of the time series. If the time series is associated with an asset property, specify one of the following: The alias of the time series. The assetId and propertyId that identifies the asset property. */ deleteTimeSeries(input: AWS.IoTSiteWise.DeleteTimeSeriesRequest, options: SdkCallOptions): Promise<{}>; /** * Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. */ describeAccessPolicy(input: AWS.IoTSiteWise.DescribeAccessPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an asset. */ describeAsset(input: AWS.IoTSiteWise.DescribeAssetRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an asset model. */ describeAssetModel(input: AWS.IoTSiteWise.DescribeAssetModelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue. */ describeAssetProperty(input: AWS.IoTSiteWise.DescribeAssetPropertyRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. */ describeBulkImportJob(input: AWS.IoTSiteWise.DescribeBulkImportJobRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a dashboard. */ describeDashboard(input: AWS.IoTSiteWise.DescribeDashboardRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide. */ describeDefaultEncryptionConfiguration(input: AWS.IoTSiteWise.DescribeDefaultEncryptionConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a gateway. */ describeGateway(input: AWS.IoTSiteWise.DescribeGatewayRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway. */ describeGatewayCapabilityConfiguration(input: AWS.IoTSiteWise.DescribeGatewayCapabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the current IoT SiteWise logging options. */ describeLoggingOptions(input: AWS.IoTSiteWise.DescribeLoggingOptionsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a portal. */ describePortal(input: AWS.IoTSiteWise.DescribePortalRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a project. */ describeProject(input: AWS.IoTSiteWise.DescribeProjectRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the storage configuration for IoT SiteWise. */ describeStorageConfiguration(input: AWS.IoTSiteWise.DescribeStorageConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a time series (data stream). To identify a time series, do one of the following: If the time series isn't associated with an asset property, specify the alias of the time series. If the time series is associated with an asset property, specify one of the following: The alias of the time series. The assetId and propertyId that identifies the asset property. */ describeTimeSeries(input: AWS.IoTSiteWise.DescribeTimeSeriesRequest, options: SdkCallOptions): Promise; /** * Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. */ disassociateAssets(input: AWS.IoTSiteWise.DisassociateAssetsRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates a time series (data stream) from an asset property. */ disassociateTimeSeriesFromAssetProperty(input: AWS.IoTSiteWise.DisassociateTimeSeriesFromAssetPropertyRequest, options: SdkCallOptions): Promise<{}>; /** * Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. */ getAssetPropertyAggregates(input: AWS.IoTSiteWise.GetAssetPropertyAggregatesRequest, options: SdkCallOptions): Promise; /** * Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. */ getAssetPropertyValue(input: AWS.IoTSiteWise.GetAssetPropertyValueRequest, options: SdkCallOptions): Promise; /** * Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. */ getAssetPropertyValueHistory(input: AWS.IoTSiteWise.GetAssetPropertyValueHistoryRequest, options: SdkCallOptions): Promise; /** * Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data. For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. */ getInterpolatedAssetPropertyValues(input: AWS.IoTSiteWise.GetInterpolatedAssetPropertyValuesRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project). */ listAccessPolicies(input: AWS.IoTSiteWise.ListAccessPoliciesRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of summaries of all asset models. */ listAssetModels(input: AWS.IoTSiteWise.ListAssetModelsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root. */ listAssetRelationships(input: AWS.IoTSiteWise.ListAssetRelationshipsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of asset summaries. You can use this operation to do the following: List assets based on a specific asset model. List top-level assets. You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model. */ listAssets(input: AWS.IoTSiteWise.ListAssetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of associated assets. You can use this operation to do the following: List child assets associated to a parent asset by a hierarchy that you specify. List an asset's parent asset. */ listAssociatedAssets(input: AWS.IoTSiteWise.ListAssociatedAssetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide. */ listBulkImportJobs(input: AWS.IoTSiteWise.ListBulkImportJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project. */ listDashboards(input: AWS.IoTSiteWise.ListDashboardsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of gateways. */ listGateways(input: AWS.IoTSiteWise.ListGatewaysRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of IoT SiteWise Monitor portals. */ listPortals(input: AWS.IoTSiteWise.ListPortalsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project. */ listProjectAssets(input: AWS.IoTSiteWise.ListProjectAssetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of projects for an IoT SiteWise Monitor portal. */ listProjects(input: AWS.IoTSiteWise.ListProjectsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of tags for an IoT SiteWise resource. */ listTagsForResource(input: AWS.IoTSiteWise.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves a paginated list of time series (data streams). */ listTimeSeries(input: AWS.IoTSiteWise.ListTimeSeriesRequest, options: SdkCallOptions): Promise; /** * Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide. */ putDefaultEncryptionConfiguration(input: AWS.IoTSiteWise.PutDefaultEncryptionConfigurationRequest, options: SdkCallOptions): Promise; /** * Sets logging options for IoT SiteWise. */ putLoggingOptions(input: AWS.IoTSiteWise.PutLoggingOptionsRequest, options: SdkCallOptions): Promise; /** * Configures storage settings for IoT SiteWise. */ putStorageConfiguration(input: AWS.IoTSiteWise.PutStorageConfigurationRequest, options: SdkCallOptions): Promise; /** * Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value. */ tagResource(input: AWS.IoTSiteWise.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from an IoT SiteWise resource. */ untagResource(input: AWS.IoTSiteWise.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. */ updateAccessPolicy(input: AWS.IoTSiteWise.UpdateAccessPolicyRequest, options: SdkCallOptions): Promise; /** * Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide. */ updateAsset(input: AWS.IoTSiteWise.UpdateAssetRequest, options: SdkCallOptions): Promise; /** * Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property. */ updateAssetModel(input: AWS.IoTSiteWise.UpdateAssetModelRequest, options: SdkCallOptions): Promise; /** * Updates an asset property's alias and notification state. This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty. */ updateAssetProperty(input: AWS.IoTSiteWise.UpdateAssetPropertyRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an IoT SiteWise Monitor dashboard. */ updateDashboard(input: AWS.IoTSiteWise.UpdateDashboardRequest, options: SdkCallOptions): Promise; /** * Updates a gateway's name. */ updateGateway(input: AWS.IoTSiteWise.UpdateGatewayRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway. */ updateGatewayCapabilityConfiguration(input: AWS.IoTSiteWise.UpdateGatewayCapabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates an IoT SiteWise Monitor portal. */ updatePortal(input: AWS.IoTSiteWise.UpdatePortalRequest, options: SdkCallOptions): Promise; /** * Updates an IoT SiteWise Monitor project. */ updateProject(input: AWS.IoTSiteWise.UpdateProjectRequest, options: SdkCallOptions): Promise; } export interface IoTThingsGraph { /** * Associates a device with a concrete thing that is in the user's registry. A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed. */ associateEntityToThing(input: AWS.IoTThingsGraph.AssociateEntityToThingRequest, options: SdkCallOptions): Promise; /** * Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request. */ createFlowTemplate(input: AWS.IoTThingsGraph.CreateFlowTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a system instance. This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action. For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error. For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes. If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default. */ createSystemInstance(input: AWS.IoTThingsGraph.CreateSystemInstanceRequest, options: SdkCallOptions): Promise; /** * Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request. */ createSystemTemplate(input: AWS.IoTThingsGraph.CreateSystemTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment). */ deleteFlowTemplate(input: AWS.IoTThingsGraph.DeleteFlowTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters. */ deleteNamespace(input: AWS.IoTThingsGraph.DeleteNamespaceRequest, options: SdkCallOptions): Promise; /** * Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted. Users can create a new system instance that has the same ID as a deleted system instance. */ deleteSystemInstance(input: AWS.IoTThingsGraph.DeleteSystemInstanceRequest, options: SdkCallOptions): Promise; /** * Deletes a system. New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed. */ deleteSystemTemplate(input: AWS.IoTThingsGraph.DeleteSystemTemplateRequest, options: SdkCallOptions): Promise; /** * Greengrass and Cloud Deployments Deploys the system instance to the target specified in CreateSystemInstance. Greengrass Deployments If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it. Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error. For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass. */ deploySystemInstance(input: AWS.IoTThingsGraph.DeploySystemInstanceRequest, options: SdkCallOptions): Promise; /** * Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run. */ deprecateFlowTemplate(input: AWS.IoTThingsGraph.DeprecateFlowTemplateRequest, options: SdkCallOptions): Promise; /** * Deprecates the specified system. */ deprecateSystemTemplate(input: AWS.IoTThingsGraph.DeprecateSystemTemplateRequest, options: SdkCallOptions): Promise; /** * Gets the latest version of the user's namespace and the public version that it is tracking. */ describeNamespace(input: AWS.IoTThingsGraph.DescribeNamespaceRequest, options: SdkCallOptions): Promise; /** * Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing. */ dissociateEntityFromThing(input: AWS.IoTThingsGraph.DissociateEntityFromThingRequest, options: SdkCallOptions): Promise; /** * Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities. Properties States Events Actions Capabilities Mappings Devices Device Models Services This action doesn't return definitions for systems, flows, and deployments. */ getEntities(input: AWS.IoTThingsGraph.GetEntitiesRequest, options: SdkCallOptions): Promise; /** * Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow. */ getFlowTemplate(input: AWS.IoTThingsGraph.GetFlowTemplateRequest, options: SdkCallOptions): Promise; /** * Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted. */ getFlowTemplateRevisions(input: AWS.IoTThingsGraph.GetFlowTemplateRevisionsRequest, options: SdkCallOptions): Promise; /** * Gets the status of a namespace deletion task. */ getNamespaceDeletionStatus(input: AWS.IoTThingsGraph.GetNamespaceDeletionStatusRequest, options: SdkCallOptions): Promise; /** * Gets a system instance. */ getSystemInstance(input: AWS.IoTThingsGraph.GetSystemInstanceRequest, options: SdkCallOptions): Promise; /** * Gets a system. */ getSystemTemplate(input: AWS.IoTThingsGraph.GetSystemTemplateRequest, options: SdkCallOptions): Promise; /** * Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted. */ getSystemTemplateRevisions(input: AWS.IoTThingsGraph.GetSystemTemplateRevisionsRequest, options: SdkCallOptions): Promise; /** * Gets the status of the specified upload. */ getUploadStatus(input: AWS.IoTThingsGraph.GetUploadStatusRequest, options: SdkCallOptions): Promise; /** * Returns a list of objects that contain information about events in a flow execution. */ listFlowExecutionMessages(input: AWS.IoTThingsGraph.ListFlowExecutionMessagesRequest, options: SdkCallOptions): Promise; /** * Lists all tags on an AWS IoT Things Graph resource. */ listTagsForResource(input: AWS.IoTThingsGraph.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking. */ searchEntities(input: AWS.IoTThingsGraph.SearchEntitiesRequest, options: SdkCallOptions): Promise; /** * Searches for AWS IoT Things Graph workflow execution instances. */ searchFlowExecutions(input: AWS.IoTThingsGraph.SearchFlowExecutionsRequest, options: SdkCallOptions): Promise; /** * Searches for summary information about workflows. */ searchFlowTemplates(input: AWS.IoTThingsGraph.SearchFlowTemplatesRequest, options: SdkCallOptions): Promise; /** * Searches for system instances in the user's account. */ searchSystemInstances(input: AWS.IoTThingsGraph.SearchSystemInstancesRequest, options: SdkCallOptions): Promise; /** * Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow. */ searchSystemTemplates(input: AWS.IoTThingsGraph.SearchSystemTemplatesRequest, options: SdkCallOptions): Promise; /** * Searches for things associated with the specified entity. You can search by both device and device model. For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2. This action searches for exact matches and doesn't perform partial text matching. */ searchThings(input: AWS.IoTThingsGraph.SearchThingsRequest, options: SdkCallOptions): Promise; /** * Creates a tag for the specified resource. */ tagResource(input: AWS.IoTThingsGraph.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a system instance from its target (Cloud or Greengrass). */ undeploySystemInstance(input: AWS.IoTThingsGraph.UndeploySystemInstanceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from the specified resource. */ untagResource(input: AWS.IoTThingsGraph.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace. */ updateFlowTemplate(input: AWS.IoTThingsGraph.UpdateFlowTemplateRequest, options: SdkCallOptions): Promise; /** * Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed. */ updateSystemTemplate(input: AWS.IoTThingsGraph.UpdateSystemTemplateRequest, options: SdkCallOptions): Promise; /** * Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded. When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true. The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace. Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum. */ uploadEntityDefinitions(input: AWS.IoTThingsGraph.UploadEntityDefinitionsRequest, options: SdkCallOptions): Promise; } export interface IoTTwinMaker { /** * Sets values for multiple time series properties. */ batchPutPropertyValues(input: AWS.IoTTwinMaker.BatchPutPropertyValuesRequest, options: SdkCallOptions): Promise; /** * Creates a component type. */ createComponentType(input: AWS.IoTTwinMaker.CreateComponentTypeRequest, options: SdkCallOptions): Promise; /** * Creates an entity. */ createEntity(input: AWS.IoTTwinMaker.CreateEntityRequest, options: SdkCallOptions): Promise; /** * Creates a scene. */ createScene(input: AWS.IoTTwinMaker.CreateSceneRequest, options: SdkCallOptions): Promise; /** * Creates a workplace. */ createWorkspace(input: AWS.IoTTwinMaker.CreateWorkspaceRequest, options: SdkCallOptions): Promise; /** * Deletes a component type. */ deleteComponentType(input: AWS.IoTTwinMaker.DeleteComponentTypeRequest, options: SdkCallOptions): Promise; /** * Deletes an entity. */ deleteEntity(input: AWS.IoTTwinMaker.DeleteEntityRequest, options: SdkCallOptions): Promise; /** * Deletes a scene. */ deleteScene(input: AWS.IoTTwinMaker.DeleteSceneRequest, options: SdkCallOptions): Promise; /** * Deletes a workspace. */ deleteWorkspace(input: AWS.IoTTwinMaker.DeleteWorkspaceRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a component type. */ getComponentType(input: AWS.IoTTwinMaker.GetComponentTypeRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an entity. */ getEntity(input: AWS.IoTTwinMaker.GetEntityRequest, options: SdkCallOptions): Promise; /** * Gets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName, componentTypeId, entityId, or workspaceId. */ getPropertyValue(input: AWS.IoTTwinMaker.GetPropertyValueRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the history of a time series property value for a component, component type, entity, or workspace. You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId. */ getPropertyValueHistory(input: AWS.IoTTwinMaker.GetPropertyValueHistoryRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a scene. */ getScene(input: AWS.IoTTwinMaker.GetSceneRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a workspace. */ getWorkspace(input: AWS.IoTTwinMaker.GetWorkspaceRequest, options: SdkCallOptions): Promise; /** * Lists all component types in a workspace. */ listComponentTypes(input: AWS.IoTTwinMaker.ListComponentTypesRequest, options: SdkCallOptions): Promise; /** * Lists all entities in a workspace. */ listEntities(input: AWS.IoTTwinMaker.ListEntitiesRequest, options: SdkCallOptions): Promise; /** * Lists all scenes in a workspace. */ listScenes(input: AWS.IoTTwinMaker.ListScenesRequest, options: SdkCallOptions): Promise; /** * Lists all tags associated with a resource. */ listTagsForResource(input: AWS.IoTTwinMaker.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves information about workspaces in the current account. */ listWorkspaces(input: AWS.IoTTwinMaker.ListWorkspacesRequest, options: SdkCallOptions): Promise; /** * Adds tags to a resource. */ tagResource(input: AWS.IoTTwinMaker.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource. */ untagResource(input: AWS.IoTTwinMaker.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates information in a component type. */ updateComponentType(input: AWS.IoTTwinMaker.UpdateComponentTypeRequest, options: SdkCallOptions): Promise; /** * Updates an entity. */ updateEntity(input: AWS.IoTTwinMaker.UpdateEntityRequest, options: SdkCallOptions): Promise; /** * Updates a scene. */ updateScene(input: AWS.IoTTwinMaker.UpdateSceneRequest, options: SdkCallOptions): Promise; /** * Updates a workspace. */ updateWorkspace(input: AWS.IoTTwinMaker.UpdateWorkspaceRequest, options: SdkCallOptions): Promise; } export interface IoTWireless { /** * Associates a partner account with your AWS account. */ associateAwsAccountWithPartnerAccount(input: AWS.IoTWireless.AssociateAwsAccountWithPartnerAccountRequest, options: SdkCallOptions): Promise; /** * Associate a multicast group with a FUOTA task. */ associateMulticastGroupWithFuotaTask(input: AWS.IoTWireless.AssociateMulticastGroupWithFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Associate a wireless device with a FUOTA task. */ associateWirelessDeviceWithFuotaTask(input: AWS.IoTWireless.AssociateWirelessDeviceWithFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Associates a wireless device with a multicast group. */ associateWirelessDeviceWithMulticastGroup(input: AWS.IoTWireless.AssociateWirelessDeviceWithMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Associates a wireless device with a thing. */ associateWirelessDeviceWithThing(input: AWS.IoTWireless.AssociateWirelessDeviceWithThingRequest, options: SdkCallOptions): Promise; /** * Associates a wireless gateway with a certificate. */ associateWirelessGatewayWithCertificate(input: AWS.IoTWireless.AssociateWirelessGatewayWithCertificateRequest, options: SdkCallOptions): Promise; /** * Associates a wireless gateway with a thing. */ associateWirelessGatewayWithThing(input: AWS.IoTWireless.AssociateWirelessGatewayWithThingRequest, options: SdkCallOptions): Promise; /** * Cancels an existing multicast group session. */ cancelMulticastGroupSession(input: AWS.IoTWireless.CancelMulticastGroupSessionRequest, options: SdkCallOptions): Promise; /** * Creates a new destination that maps a device message to an AWS IoT rule. */ createDestination(input: AWS.IoTWireless.CreateDestinationRequest, options: SdkCallOptions): Promise; /** * Creates a new device profile. */ createDeviceProfile(input: AWS.IoTWireless.CreateDeviceProfileRequest, options: SdkCallOptions): Promise; /** * Creates a FUOTA task. */ createFuotaTask(input: AWS.IoTWireless.CreateFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Creates a multicast group. */ createMulticastGroup(input: AWS.IoTWireless.CreateMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Creates a new network analyzer configuration. */ createNetworkAnalyzerConfiguration(input: AWS.IoTWireless.CreateNetworkAnalyzerConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a new service profile. */ createServiceProfile(input: AWS.IoTWireless.CreateServiceProfileRequest, options: SdkCallOptions): Promise; /** * Provisions a wireless device. */ createWirelessDevice(input: AWS.IoTWireless.CreateWirelessDeviceRequest, options: SdkCallOptions): Promise; /** * Provisions a wireless gateway. */ createWirelessGateway(input: AWS.IoTWireless.CreateWirelessGatewayRequest, options: SdkCallOptions): Promise; /** * Creates a task for a wireless gateway. */ createWirelessGatewayTask(input: AWS.IoTWireless.CreateWirelessGatewayTaskRequest, options: SdkCallOptions): Promise; /** * Creates a gateway task definition. */ createWirelessGatewayTaskDefinition(input: AWS.IoTWireless.CreateWirelessGatewayTaskDefinitionRequest, options: SdkCallOptions): Promise; /** * Deletes a destination. */ deleteDestination(input: AWS.IoTWireless.DeleteDestinationRequest, options: SdkCallOptions): Promise; /** * Deletes a device profile. */ deleteDeviceProfile(input: AWS.IoTWireless.DeleteDeviceProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a FUOTA task. */ deleteFuotaTask(input: AWS.IoTWireless.DeleteFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Deletes a multicast group if it is not in use by a fuota task. */ deleteMulticastGroup(input: AWS.IoTWireless.DeleteMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a network analyzer configuration. */ deleteNetworkAnalyzerConfiguration(input: AWS.IoTWireless.DeleteNetworkAnalyzerConfigurationRequest, options: SdkCallOptions): Promise; /** * Remove queued messages from the downlink queue. */ deleteQueuedMessages(input: AWS.IoTWireless.DeleteQueuedMessagesRequest, options: SdkCallOptions): Promise; /** * Deletes a service profile. */ deleteServiceProfile(input: AWS.IoTWireless.DeleteServiceProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a wireless device. */ deleteWirelessDevice(input: AWS.IoTWireless.DeleteWirelessDeviceRequest, options: SdkCallOptions): Promise; /** * Deletes a wireless gateway. */ deleteWirelessGateway(input: AWS.IoTWireless.DeleteWirelessGatewayRequest, options: SdkCallOptions): Promise; /** * Deletes a wireless gateway task. */ deleteWirelessGatewayTask(input: AWS.IoTWireless.DeleteWirelessGatewayTaskRequest, options: SdkCallOptions): Promise; /** * Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress. */ deleteWirelessGatewayTaskDefinition(input: AWS.IoTWireless.DeleteWirelessGatewayTaskDefinitionRequest, options: SdkCallOptions): Promise; /** * Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts. */ disassociateAwsAccountFromPartnerAccount(input: AWS.IoTWireless.DisassociateAwsAccountFromPartnerAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates a multicast group from a fuota task. */ disassociateMulticastGroupFromFuotaTask(input: AWS.IoTWireless.DisassociateMulticastGroupFromFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Disassociates a wireless device from a FUOTA task. */ disassociateWirelessDeviceFromFuotaTask(input: AWS.IoTWireless.DisassociateWirelessDeviceFromFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Disassociates a wireless device from a multicast group. */ disassociateWirelessDeviceFromMulticastGroup(input: AWS.IoTWireless.DisassociateWirelessDeviceFromMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Disassociates a wireless device from its currently associated thing. */ disassociateWirelessDeviceFromThing(input: AWS.IoTWireless.DisassociateWirelessDeviceFromThingRequest, options: SdkCallOptions): Promise; /** * Disassociates a wireless gateway from its currently associated certificate. */ disassociateWirelessGatewayFromCertificate(input: AWS.IoTWireless.DisassociateWirelessGatewayFromCertificateRequest, options: SdkCallOptions): Promise; /** * Disassociates a wireless gateway from its currently associated thing. */ disassociateWirelessGatewayFromThing(input: AWS.IoTWireless.DisassociateWirelessGatewayFromThingRequest, options: SdkCallOptions): Promise; /** * Gets information about a destination. */ getDestination(input: AWS.IoTWireless.GetDestinationRequest, options: SdkCallOptions): Promise; /** * Gets information about a device profile. */ getDeviceProfile(input: AWS.IoTWireless.GetDeviceProfileRequest, options: SdkCallOptions): Promise; /** * Get the event configuration based on resource types. */ getEventConfigurationByResourceTypes(input: AWS.IoTWireless.GetEventConfigurationByResourceTypesRequest, options: SdkCallOptions): Promise; /** * Gets information about a FUOTA task. */ getFuotaTask(input: AWS.IoTWireless.GetFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options. */ getLogLevelsByResourceTypes(input: AWS.IoTWireless.GetLogLevelsByResourceTypesRequest, options: SdkCallOptions): Promise; /** * Gets information about a multicast group. */ getMulticastGroup(input: AWS.IoTWireless.GetMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Gets information about a multicast group session. */ getMulticastGroupSession(input: AWS.IoTWireless.GetMulticastGroupSessionRequest, options: SdkCallOptions): Promise; /** * Get network analyzer configuration. */ getNetworkAnalyzerConfiguration(input: AWS.IoTWireless.GetNetworkAnalyzerConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts. */ getPartnerAccount(input: AWS.IoTWireless.GetPartnerAccountRequest, options: SdkCallOptions): Promise; /** * Get the position information for a given resource. */ getPosition(input: AWS.IoTWireless.GetPositionRequest, options: SdkCallOptions): Promise; /** * Get position configuration for a given resource. */ getPositionConfiguration(input: AWS.IoTWireless.GetPositionConfigurationRequest, options: SdkCallOptions): Promise; /** * Get the event configuration for a particular resource identifier. */ getResourceEventConfiguration(input: AWS.IoTWireless.GetResourceEventConfigurationRequest, options: SdkCallOptions): Promise; /** * Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway. */ getResourceLogLevel(input: AWS.IoTWireless.GetResourceLogLevelRequest, options: SdkCallOptions): Promise; /** * Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections. */ getServiceEndpoint(input: AWS.IoTWireless.GetServiceEndpointRequest, options: SdkCallOptions): Promise; /** * Gets information about a service profile. */ getServiceProfile(input: AWS.IoTWireless.GetServiceProfileRequest, options: SdkCallOptions): Promise; /** * Gets information about a wireless device. */ getWirelessDevice(input: AWS.IoTWireless.GetWirelessDeviceRequest, options: SdkCallOptions): Promise; /** * Gets operating information about a wireless device. */ getWirelessDeviceStatistics(input: AWS.IoTWireless.GetWirelessDeviceStatisticsRequest, options: SdkCallOptions): Promise; /** * Gets information about a wireless gateway. */ getWirelessGateway(input: AWS.IoTWireless.GetWirelessGatewayRequest, options: SdkCallOptions): Promise; /** * Gets the ID of the certificate that is currently associated with a wireless gateway. */ getWirelessGatewayCertificate(input: AWS.IoTWireless.GetWirelessGatewayCertificateRequest, options: SdkCallOptions): Promise; /** * Gets the firmware version and other information about a wireless gateway. */ getWirelessGatewayFirmwareInformation(input: AWS.IoTWireless.GetWirelessGatewayFirmwareInformationRequest, options: SdkCallOptions): Promise; /** * Gets operating information about a wireless gateway. */ getWirelessGatewayStatistics(input: AWS.IoTWireless.GetWirelessGatewayStatisticsRequest, options: SdkCallOptions): Promise; /** * Gets information about a wireless gateway task. */ getWirelessGatewayTask(input: AWS.IoTWireless.GetWirelessGatewayTaskRequest, options: SdkCallOptions): Promise; /** * Gets information about a wireless gateway task definition. */ getWirelessGatewayTaskDefinition(input: AWS.IoTWireless.GetWirelessGatewayTaskDefinitionRequest, options: SdkCallOptions): Promise; /** * Lists the destinations registered to your AWS account. */ listDestinations(input: AWS.IoTWireless.ListDestinationsRequest, options: SdkCallOptions): Promise; /** * Lists the device profiles registered to your AWS account. */ listDeviceProfiles(input: AWS.IoTWireless.ListDeviceProfilesRequest, options: SdkCallOptions): Promise; /** * List event configurations where at least one event topic has been enabled. */ listEventConfigurations(input: AWS.IoTWireless.ListEventConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists the FUOTA tasks registered to your AWS account. */ listFuotaTasks(input: AWS.IoTWireless.ListFuotaTasksRequest, options: SdkCallOptions): Promise; /** * Lists the multicast groups registered to your AWS account. */ listMulticastGroups(input: AWS.IoTWireless.ListMulticastGroupsRequest, options: SdkCallOptions): Promise; /** * List all multicast groups associated with a fuota task. */ listMulticastGroupsByFuotaTask(input: AWS.IoTWireless.ListMulticastGroupsByFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Lists the network analyzer configurations. */ listNetworkAnalyzerConfigurations(input: AWS.IoTWireless.ListNetworkAnalyzerConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists the partner accounts associated with your AWS account. */ listPartnerAccounts(input: AWS.IoTWireless.ListPartnerAccountsRequest, options: SdkCallOptions): Promise; /** * List position configurations for a given resource, such as positioning solvers. */ listPositionConfigurations(input: AWS.IoTWireless.ListPositionConfigurationsRequest, options: SdkCallOptions): Promise; /** * List queued messages in the downlink queue. */ listQueuedMessages(input: AWS.IoTWireless.ListQueuedMessagesRequest, options: SdkCallOptions): Promise; /** * Lists the service profiles registered to your AWS account. */ listServiceProfiles(input: AWS.IoTWireless.ListServiceProfilesRequest, options: SdkCallOptions): Promise; /** * Lists the tags (metadata) you have assigned to the resource. */ listTagsForResource(input: AWS.IoTWireless.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the wireless devices registered to your AWS account. */ listWirelessDevices(input: AWS.IoTWireless.ListWirelessDevicesRequest, options: SdkCallOptions): Promise; /** * List the wireless gateway tasks definitions registered to your AWS account. */ listWirelessGatewayTaskDefinitions(input: AWS.IoTWireless.ListWirelessGatewayTaskDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists the wireless gateways registered to your AWS account. */ listWirelessGateways(input: AWS.IoTWireless.ListWirelessGatewaysRequest, options: SdkCallOptions): Promise; /** * Put position configuration for a given resource. */ putPositionConfiguration(input: AWS.IoTWireless.PutPositionConfigurationRequest, options: SdkCallOptions): Promise; /** * Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account. */ putResourceLogLevel(input: AWS.IoTWireless.PutResourceLogLevelRequest, options: SdkCallOptions): Promise; /** * Removes the log-level overrides for all resources; both wireless devices and wireless gateways. */ resetAllResourceLogLevels(input: AWS.IoTWireless.ResetAllResourceLogLevelsRequest, options: SdkCallOptions): Promise; /** * Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway. */ resetResourceLogLevel(input: AWS.IoTWireless.ResetResourceLogLevelRequest, options: SdkCallOptions): Promise; /** * Sends the specified data to a multicast group. */ sendDataToMulticastGroup(input: AWS.IoTWireless.SendDataToMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Sends a decrypted application data frame to a device. */ sendDataToWirelessDevice(input: AWS.IoTWireless.SendDataToWirelessDeviceRequest, options: SdkCallOptions): Promise; /** * Starts a bulk association of all qualifying wireless devices with a multicast group. */ startBulkAssociateWirelessDeviceWithMulticastGroup(input: AWS.IoTWireless.StartBulkAssociateWirelessDeviceWithMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Starts a bulk disassociatin of all qualifying wireless devices from a multicast group. */ startBulkDisassociateWirelessDeviceFromMulticastGroup(input: AWS.IoTWireless.StartBulkDisassociateWirelessDeviceFromMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Starts a FUOTA task. */ startFuotaTask(input: AWS.IoTWireless.StartFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Starts a multicast group session. */ startMulticastGroupSession(input: AWS.IoTWireless.StartMulticastGroupSessionRequest, options: SdkCallOptions): Promise; /** * Adds a tag to a resource. */ tagResource(input: AWS.IoTWireless.TagResourceRequest, options: SdkCallOptions): Promise; /** * Simulates a provisioned device by sending an uplink data payload of Hello. */ testWirelessDevice(input: AWS.IoTWireless.TestWirelessDeviceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a resource. */ untagResource(input: AWS.IoTWireless.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates properties of a destination. */ updateDestination(input: AWS.IoTWireless.UpdateDestinationRequest, options: SdkCallOptions): Promise; /** * Update the event configuration based on resource types. */ updateEventConfigurationByResourceTypes(input: AWS.IoTWireless.UpdateEventConfigurationByResourceTypesRequest, options: SdkCallOptions): Promise; /** * Updates properties of a FUOTA task. */ updateFuotaTask(input: AWS.IoTWireless.UpdateFuotaTaskRequest, options: SdkCallOptions): Promise; /** * Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch. */ updateLogLevelsByResourceTypes(input: AWS.IoTWireless.UpdateLogLevelsByResourceTypesRequest, options: SdkCallOptions): Promise; /** * Updates properties of a multicast group session. */ updateMulticastGroup(input: AWS.IoTWireless.UpdateMulticastGroupRequest, options: SdkCallOptions): Promise; /** * Update network analyzer configuration. */ updateNetworkAnalyzerConfiguration(input: AWS.IoTWireless.UpdateNetworkAnalyzerConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates properties of a partner account. */ updatePartnerAccount(input: AWS.IoTWireless.UpdatePartnerAccountRequest, options: SdkCallOptions): Promise; /** * Update the position information of a resource. */ updatePosition(input: AWS.IoTWireless.UpdatePositionRequest, options: SdkCallOptions): Promise; /** * Update the event configuration for a particular resource identifier. */ updateResourceEventConfiguration(input: AWS.IoTWireless.UpdateResourceEventConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates properties of a wireless device. */ updateWirelessDevice(input: AWS.IoTWireless.UpdateWirelessDeviceRequest, options: SdkCallOptions): Promise; /** * Updates properties of a wireless gateway. */ updateWirelessGateway(input: AWS.IoTWireless.UpdateWirelessGatewayRequest, options: SdkCallOptions): Promise; } export interface IVS { /** * Performs GetChannel on multiple ARNs simultaneously. */ batchGetChannel(input: AWS.IVS.BatchGetChannelRequest, options: SdkCallOptions): Promise; /** * Performs GetStreamKey on multiple ARNs simultaneously. */ batchGetStreamKey(input: AWS.IVS.BatchGetStreamKeyRequest, options: SdkCallOptions): Promise; /** * Creates a new channel and an associated stream key to start streaming. */ createChannel(input: AWS.IVS.CreateChannelRequest, options: SdkCallOptions): Promise; /** * Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.) Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region. */ createRecordingConfiguration(input: AWS.IVS.CreateRecordingConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey. */ createStreamKey(input: AWS.IVS.CreateStreamKeyRequest, options: SdkCallOptions): Promise; /** * Deletes the specified channel and its associated stream keys. If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.) */ deleteChannel(input: AWS.IVS.DeleteChannelRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide. */ deletePlaybackKeyPair(input: AWS.IVS.DeletePlaybackKeyPairRequest, options: SdkCallOptions): Promise; /** * Deletes the recording configuration for the specified ARN. If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration. */ deleteRecordingConfiguration(input: AWS.IVS.DeleteRecordingConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the stream key for the specified ARN, so it can no longer be used to stream. */ deleteStreamKey(input: AWS.IVS.DeleteStreamKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Gets the channel configuration for the specified channel ARN. See also BatchGetChannel. */ getChannel(input: AWS.IVS.GetChannelRequest, options: SdkCallOptions): Promise; /** * Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide. */ getPlaybackKeyPair(input: AWS.IVS.GetPlaybackKeyPairRequest, options: SdkCallOptions): Promise; /** * Gets the recording configuration for the specified ARN. */ getRecordingConfiguration(input: AWS.IVS.GetRecordingConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets information about the active (live) stream on a specified channel. */ getStream(input: AWS.IVS.GetStreamRequest, options: SdkCallOptions): Promise; /** * Gets stream-key information for a specified ARN. */ getStreamKey(input: AWS.IVS.GetStreamKeyRequest, options: SdkCallOptions): Promise; /** * Gets metadata on a specified stream. */ getStreamSession(input: AWS.IVS.GetStreamSessionRequest, options: SdkCallOptions): Promise; /** * Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide. */ importPlaybackKeyPair(input: AWS.IVS.ImportPlaybackKeyPairRequest, options: SdkCallOptions): Promise; /** * Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException). */ listChannels(input: AWS.IVS.ListChannelsRequest, options: SdkCallOptions): Promise; /** * Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide. */ listPlaybackKeyPairs(input: AWS.IVS.ListPlaybackKeyPairsRequest, options: SdkCallOptions): Promise; /** * Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed. */ listRecordingConfigurations(input: AWS.IVS.ListRecordingConfigurationsRequest, options: SdkCallOptions): Promise; /** * Gets summary information about stream keys for the specified channel. */ listStreamKeys(input: AWS.IVS.ListStreamKeysRequest, options: SdkCallOptions): Promise; /** * Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed. */ listStreamSessions(input: AWS.IVS.ListStreamSessionsRequest, options: SdkCallOptions): Promise; /** * Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed. */ listStreams(input: AWS.IVS.ListStreamsRequest, options: SdkCallOptions): Promise; /** * Gets information about Amazon Web Services tags for the specified ARN. */ listTagsForResource(input: AWS.IVS.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide. */ putMetadata(input: AWS.IVS.PutMetadataRequest, options: SdkCallOptions): Promise<{}>; /** * Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel. Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel. */ stopStream(input: AWS.IVS.StopStreamRequest, options: SdkCallOptions): Promise; /** * Adds or updates tags for the Amazon Web Services resource with the specified ARN. */ tagResource(input: AWS.IVS.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from the resource with the specified ARN. */ untagResource(input: AWS.IVS.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect. */ updateChannel(input: AWS.IVS.UpdateChannelRequest, options: SdkCallOptions): Promise; } export interface Ivschat { /** * Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration. Encryption keys are owned by Amazon IVS Chat and never used directly by your application. */ createChatToken(input: AWS.Ivschat.CreateChatTokenRequest, options: SdkCallOptions): Promise; /** * Creates a room that allows clients to connect and pass messages. */ createRoom(input: AWS.Ivschat.CreateRoomRequest, options: SdkCallOptions): Promise; /** * Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API. */ deleteMessage(input: AWS.Ivschat.DeleteMessageRequest, options: SdkCallOptions): Promise; /** * Deletes the specified room. */ deleteRoom(input: AWS.Ivschat.DeleteRoomRequest, options: SdkCallOptions): Promise<{}>; /** * Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API. */ disconnectUser(input: AWS.Ivschat.DisconnectUserRequest, options: SdkCallOptions): Promise; /** * Gets the specified room. */ getRoom(input: AWS.Ivschat.GetRoomRequest, options: SdkCallOptions): Promise; /** * Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime. */ listRooms(input: AWS.Ivschat.ListRoomsRequest, options: SdkCallOptions): Promise; /** * Gets information about AWS tags for the specified ARN. */ listTagsForResource(input: AWS.Ivschat.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered. */ sendEvent(input: AWS.Ivschat.SendEventRequest, options: SdkCallOptions): Promise; /** * Adds or updates tags for the AWS resource with the specified ARN. */ tagResource(input: AWS.Ivschat.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from the resource with the specified ARN. */ untagResource(input: AWS.Ivschat.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a room’s configuration. */ updateRoom(input: AWS.Ivschat.UpdateRoomRequest, options: SdkCallOptions): Promise; } export interface Kafka { /** * Associates one or more Scram Secrets with an Amazon MSK cluster. */ batchAssociateScramSecret(input: AWS.Kafka.BatchAssociateScramSecretRequest, options: SdkCallOptions): Promise; /** * Creates a new MSK cluster. */ createCluster(input: AWS.Kafka.CreateClusterRequest, options: SdkCallOptions): Promise; /** * Creates a new MSK cluster. */ createClusterV2(input: AWS.Kafka.CreateClusterV2Request, options: SdkCallOptions): Promise; /** * Creates a new MSK configuration. */ createConfiguration(input: AWS.Kafka.CreateConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request. */ deleteCluster(input: AWS.Kafka.DeleteClusterRequest, options: SdkCallOptions): Promise; /** * Deletes an MSK Configuration. */ deleteConfiguration(input: AWS.Kafka.DeleteConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. */ describeCluster(input: AWS.Kafka.DescribeClusterRequest, options: SdkCallOptions): Promise; /** * Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. */ describeClusterV2(input: AWS.Kafka.DescribeClusterV2Request, options: SdkCallOptions): Promise; /** * Returns a description of the cluster operation specified by the ARN. */ describeClusterOperation(input: AWS.Kafka.DescribeClusterOperationRequest, options: SdkCallOptions): Promise; /** * Returns a description of this MSK configuration. */ describeConfiguration(input: AWS.Kafka.DescribeConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns a description of this revision of the configuration. */ describeConfigurationRevision(input: AWS.Kafka.DescribeConfigurationRevisionRequest, options: SdkCallOptions): Promise; /** * Disassociates one or more Scram Secrets from an Amazon MSK cluster. */ batchDisassociateScramSecret(input: AWS.Kafka.BatchDisassociateScramSecretRequest, options: SdkCallOptions): Promise; /** * A list of brokers that a client application can use to bootstrap. */ getBootstrapBrokers(input: AWS.Kafka.GetBootstrapBrokersRequest, options: SdkCallOptions): Promise; /** * Gets the Apache Kafka versions to which you can update the MSK cluster. */ getCompatibleKafkaVersions(input: AWS.Kafka.GetCompatibleKafkaVersionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all the operations that have been performed on the specified MSK cluster. */ listClusterOperations(input: AWS.Kafka.ListClusterOperationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all the MSK clusters in the current Region. */ listClusters(input: AWS.Kafka.ListClustersRequest, options: SdkCallOptions): Promise; /** * Returns a list of all the MSK clusters in the current Region. */ listClustersV2(input: AWS.Kafka.ListClustersV2Request, options: SdkCallOptions): Promise; /** * Returns a list of all the MSK configurations in this Region. */ listConfigurationRevisions(input: AWS.Kafka.ListConfigurationRevisionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all the MSK configurations in this Region. */ listConfigurations(input: AWS.Kafka.ListConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Apache Kafka versions. */ listKafkaVersions(input: AWS.Kafka.ListKafkaVersionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the broker nodes in the cluster. */ listNodes(input: AWS.Kafka.ListNodesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the Scram Secrets associated with an Amazon MSK cluster. */ listScramSecrets(input: AWS.Kafka.ListScramSecretsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags associated with the specified resource. */ listTagsForResource(input: AWS.Kafka.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Reboots brokers. */ rebootBroker(input: AWS.Kafka.RebootBrokerRequest, options: SdkCallOptions): Promise; /** * Adds tags to the specified MSK resource. */ tagResource(input: AWS.Kafka.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the tags associated with the keys that are provided in the query. */ untagResource(input: AWS.Kafka.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the number of broker nodes in the cluster. */ updateBrokerCount(input: AWS.Kafka.UpdateBrokerCountRequest, options: SdkCallOptions): Promise; /** * Updates EC2 instance type. */ updateBrokerType(input: AWS.Kafka.UpdateBrokerTypeRequest, options: SdkCallOptions): Promise; /** * Updates the EBS storage associated with MSK brokers. */ updateBrokerStorage(input: AWS.Kafka.UpdateBrokerStorageRequest, options: SdkCallOptions): Promise; /** * Updates an MSK configuration. */ updateConfiguration(input: AWS.Kafka.UpdateConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the cluster's connectivity configuration. */ updateConnectivity(input: AWS.Kafka.UpdateConnectivityRequest, options: SdkCallOptions): Promise; /** * Updates the cluster with the configuration that is specified in the request body. */ updateClusterConfiguration(input: AWS.Kafka.UpdateClusterConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the Apache Kafka version for the cluster. */ updateClusterKafkaVersion(input: AWS.Kafka.UpdateClusterKafkaVersionRequest, options: SdkCallOptions): Promise; /** * Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus. */ updateMonitoring(input: AWS.Kafka.UpdateMonitoringRequest, options: SdkCallOptions): Promise; /** * Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters. */ updateSecurity(input: AWS.Kafka.UpdateSecurityRequest, options: SdkCallOptions): Promise; } export interface KafkaConnect { /** * Creates a connector using the specified properties. */ createConnector(input: AWS.KafkaConnect.CreateConnectorRequest, options: SdkCallOptions): Promise; /** * Creates a custom plugin using the specified properties. */ createCustomPlugin(input: AWS.KafkaConnect.CreateCustomPluginRequest, options: SdkCallOptions): Promise; /** * Creates a worker configuration using the specified properties. */ createWorkerConfiguration(input: AWS.KafkaConnect.CreateWorkerConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified connector. */ deleteConnector(input: AWS.KafkaConnect.DeleteConnectorRequest, options: SdkCallOptions): Promise; /** * Deletes a custom plugin. */ deleteCustomPlugin(input: AWS.KafkaConnect.DeleteCustomPluginRequest, options: SdkCallOptions): Promise; /** * Returns summary information about the connector. */ describeConnector(input: AWS.KafkaConnect.DescribeConnectorRequest, options: SdkCallOptions): Promise; /** * A summary description of the custom plugin. */ describeCustomPlugin(input: AWS.KafkaConnect.DescribeCustomPluginRequest, options: SdkCallOptions): Promise; /** * Returns information about a worker configuration. */ describeWorkerConfiguration(input: AWS.KafkaConnect.DescribeWorkerConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors. */ listConnectors(input: AWS.KafkaConnect.ListConnectorsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all of the custom plugins in this account and Region. */ listCustomPlugins(input: AWS.KafkaConnect.ListCustomPluginsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all of the worker configurations in this account and Region. */ listWorkerConfigurations(input: AWS.KafkaConnect.ListWorkerConfigurationsRequest, options: SdkCallOptions): Promise; /** * Updates the specified connector. */ updateConnector(input: AWS.KafkaConnect.UpdateConnectorRequest, options: SdkCallOptions): Promise; } export interface Kendra { /** * Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ associateEntitiesToExperience(input: AWS.Kendra.AssociateEntitiesToExperienceRequest, options: SdkCallOptions): Promise; /** * Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ associatePersonasToEntities(input: AWS.Kendra.AssociatePersonasToEntitiesRequest, options: SdkCallOptions): Promise; /** * Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log. */ batchDeleteDocument(input: AWS.Kendra.BatchDeleteDocumentRequest, options: SdkCallOptions): Promise; /** * Returns the indexing status for one or more documents submitted with the BatchPutDocument API. When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed. You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status. */ batchGetDocumentStatus(input: AWS.Kendra.BatchGetDocumentStatusRequest, options: SdkCallOptions): Promise; /** * Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index. */ batchPutDocument(input: AWS.Kendra.BatchPutDocumentRequest, options: SdkCallOptions): Promise; /** * Clears existing query suggestions from an index. This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions. ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ clearQuerySuggestions(input: AWS.Kendra.ClearQuerySuggestionsRequest, options: SdkCallOptions): Promise<{}>; /** * Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change. To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API. */ createAccessControlConfiguration(input: AWS.Kendra.CreateAccessControlConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK. */ createDataSource(input: AWS.Kendra.CreateDataSourceRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code. */ createExperience(input: AWS.Kendra.CreateExperienceRequest, options: SdkCallOptions): Promise; /** * Creates an new set of frequently asked question (FAQ) questions and answers. Adding FAQs to an index is an asynchronous operation. For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file. */ createFaq(input: AWS.Kendra.CreateFaqRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK. */ createIndex(input: AWS.Kendra.CreateIndexRequest, options: SdkCallOptions): Promise; /** * Creates a block list to exlcude certain queries from suggestions. Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion. You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line. For information on the current quota limits for block lists, see Quotas for Amazon Kendra. CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region. For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list. */ createQuerySuggestionsBlockList(input: AWS.Kendra.CreateQuerySuggestionsBlockListRequest, options: SdkCallOptions): Promise; /** * Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format. For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index. */ createThesaurus(input: AWS.Kendra.CreateThesaurusRequest, options: SdkCallOptions): Promise; /** * Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. */ deleteAccessControlConfiguration(input: AWS.Kendra.DeleteAccessControlConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources. */ deleteDataSource(input: AWS.Kendra.DeleteDataSourceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ deleteExperience(input: AWS.Kendra.DeleteExperienceRequest, options: SdkCallOptions): Promise; /** * Removes an FAQ from an index. */ deleteFaq(input: AWS.Kendra.DeleteFaqRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING. */ deleteIndex(input: AWS.Kendra.DeleteIndexRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results. If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping. DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ deletePrincipalMapping(input: AWS.Kendra.DeletePrincipalMappingRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a block list used for query suggestions for an index. A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked. DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ deleteQuerySuggestionsBlockList(input: AWS.Kendra.DeleteQuerySuggestionsBlockListRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing Amazon Kendra thesaurus. */ deleteThesaurus(input: AWS.Kendra.DeleteThesaurusRequest, options: SdkCallOptions): Promise<{}>; /** * Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. */ describeAccessControlConfiguration(input: AWS.Kendra.DescribeAccessControlConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets information about an Amazon Kendra data source connector. */ describeDataSource(input: AWS.Kendra.DescribeDataSourceRequest, options: SdkCallOptions): Promise; /** * Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ describeExperience(input: AWS.Kendra.DescribeExperienceRequest, options: SdkCallOptions): Promise; /** * Gets information about an FAQ list. */ describeFaq(input: AWS.Kendra.DescribeFaqRequest, options: SdkCallOptions): Promise; /** * Gets information about an existing Amazon Kendra index. */ describeIndex(input: AWS.Kendra.DescribeIndexRequest, options: SdkCallOptions): Promise; /** * Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed. DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ describePrincipalMapping(input: AWS.Kendra.DescribePrincipalMappingRequest, options: SdkCallOptions): Promise; /** * Gets information about a block list used for query suggestions for an index. This is used to check the current settings that are applied to a block list. DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ describeQuerySuggestionsBlockList(input: AWS.Kendra.DescribeQuerySuggestionsBlockListRequest, options: SdkCallOptions): Promise; /** * Gets information on the settings of query suggestions for an index. This is used to check the current settings applied to query suggestions. DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ describeQuerySuggestionsConfig(input: AWS.Kendra.DescribeQuerySuggestionsConfigRequest, options: SdkCallOptions): Promise; /** * Gets information about an existing Amazon Kendra thesaurus. */ describeThesaurus(input: AWS.Kendra.DescribeThesaurusRequest, options: SdkCallOptions): Promise; /** * Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ disassociateEntitiesFromExperience(input: AWS.Kendra.DisassociateEntitiesFromExperienceRequest, options: SdkCallOptions): Promise; /** * Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ disassociatePersonasFromEntities(input: AWS.Kendra.DisassociatePersonasFromEntitiesRequest, options: SdkCallOptions): Promise; /** * Fetches the queries that are suggested to your users. GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ getQuerySuggestions(input: AWS.Kendra.GetQuerySuggestionsRequest, options: SdkCallOptions): Promise; /** * Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is. */ getSnapshots(input: AWS.Kendra.GetSnapshotsRequest, options: SdkCallOptions): Promise; /** * Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. */ listAccessControlConfigurations(input: AWS.Kendra.ListAccessControlConfigurationsRequest, options: SdkCallOptions): Promise; /** * Gets statistics about synchronizing a data source connector. */ listDataSourceSyncJobs(input: AWS.Kendra.ListDataSourceSyncJobsRequest, options: SdkCallOptions): Promise; /** * Lists the data source connectors that you have created. */ listDataSources(input: AWS.Kendra.ListDataSourcesRequest, options: SdkCallOptions): Promise; /** * Lists specific permissions of users and groups with access to your Amazon Kendra experience. */ listEntityPersonas(input: AWS.Kendra.ListEntityPersonasRequest, options: SdkCallOptions): Promise; /** * Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ listExperienceEntities(input: AWS.Kendra.ListExperienceEntitiesRequest, options: SdkCallOptions): Promise; /** * Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ listExperiences(input: AWS.Kendra.ListExperiencesRequest, options: SdkCallOptions): Promise; /** * Gets a list of FAQ lists associated with an index. */ listFaqs(input: AWS.Kendra.ListFaqsRequest, options: SdkCallOptions): Promise; /** * Provides a list of groups that are mapped to users before a given ordering or timestamp identifier. ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ listGroupsOlderThanOrderingId(input: AWS.Kendra.ListGroupsOlderThanOrderingIdRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon Kendra indexes that you created. */ listIndices(input: AWS.Kendra.ListIndicesRequest, options: SdkCallOptions): Promise; /** * Lists the block lists used for query suggestions for an index. For information on the current quota limits for block lists, see Quotas for Amazon Kendra. ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ listQuerySuggestionsBlockLists(input: AWS.Kendra.ListQuerySuggestionsBlockListsRequest, options: SdkCallOptions): Promise; /** * Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them. */ listTagsForResource(input: AWS.Kendra.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the thesauri for an index. */ listThesauri(input: AWS.Kendra.ListThesauriRequest, options: SdkCallOptions): Promise; /** * Maps users to their groups so that you only need to provide the user ID when you issue the query. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context. If more than five PUT actions for a group are currently processing, a validation exception is thrown. PutPrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ putPrincipalMapping(input: AWS.Kendra.PutPrincipalMappingRequest, options: SdkCallOptions): Promise<{}>; /** * Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes. It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results. Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results. Relevant passages Matching FAQs Relevant documents You can specify that the query return only one type of result using the QueryResultTypeConfig parameter. Each query returns the 100 most relevant results. */ query(input: AWS.Kendra.QueryRequest, options: SdkCallOptions): Promise; /** * Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception. */ startDataSourceSyncJob(input: AWS.Kendra.StartDataSourceSyncJobRequest, options: SdkCallOptions): Promise; /** * Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job. */ stopDataSourceSyncJob(input: AWS.Kendra.StopDataSourceSyncJobRequest, options: SdkCallOptions): Promise<{}>; /** * Enables you to provide feedback to Amazon Kendra to improve the performance of your index. SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ submitFeedback(input: AWS.Kendra.SubmitFeedbackRequest, options: SdkCallOptions): Promise<{}>; /** * Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value. */ tagResource(input: AWS.Kendra.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from an index, FAQ, or a data source. */ untagResource(input: AWS.Kendra.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change. You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API. */ updateAccessControlConfiguration(input: AWS.Kendra.UpdateAccessControlConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates an existing Amazon Kendra data source connector. */ updateDataSource(input: AWS.Kendra.UpdateDataSourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code. */ updateExperience(input: AWS.Kendra.UpdateExperienceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an existing Amazon Kendra index. */ updateIndex(input: AWS.Kendra.UpdateIndexRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a block list used for query suggestions for an index. Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately. If a block list is updating, then you need to wait for the first update to finish before submitting another update. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ updateQuerySuggestionsBlockList(input: AWS.Kendra.UpdateQuerySuggestionsBlockListRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the settings of query suggestions for an index. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update. Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index. You can still enable/disable query suggestions at any time. UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region. */ updateQuerySuggestionsConfig(input: AWS.Kendra.UpdateQuerySuggestionsConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a thesaurus for an index. */ updateThesaurus(input: AWS.Kendra.UpdateThesaurusRequest, options: SdkCallOptions): Promise<{}>; } export interface Keyspaces { /** * The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region. CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation. For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide. */ createKeyspace(input: AWS.Keyspaces.CreateKeyspaceRequest, options: SdkCallOptions): Promise; /** * The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique. CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. You can monitor the creation status of the new table by using the GetTable operation, which returns the current status of the table. You can start using a table when the status is ACTIVE. For more information, see Creating tables in the Amazon Keyspaces Developer Guide. */ createTable(input: AWS.Keyspaces.CreateTableRequest, options: SdkCallOptions): Promise; /** * The DeleteKeyspace operation deletes a keyspace and all of its tables. */ deleteKeyspace(input: AWS.Keyspaces.DeleteKeyspaceRequest, options: SdkCallOptions): Promise; /** * The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned. */ deleteTable(input: AWS.Keyspaces.DeleteTableRequest, options: SdkCallOptions): Promise; /** * Returns the name and the Amazon Resource Name (ARN) of the specified table. */ getKeyspace(input: AWS.Keyspaces.GetKeyspaceRequest, options: SdkCallOptions): Promise; /** * Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata. To read table metadata using GetTable, Select action permissions for the table and system tables are required to complete the operation. */ getTable(input: AWS.Keyspaces.GetTableRequest, options: SdkCallOptions): Promise; /** * Returns a list of keyspaces. */ listKeyspaces(input: AWS.Keyspaces.ListKeyspacesRequest, options: SdkCallOptions): Promise; /** * Returns a list of tables for a specified keyspace. */ listTables(input: AWS.Keyspaces.ListTablesRequest, options: SdkCallOptions): Promise; /** * Returns a list of all tags associated with the specified Amazon Keyspaces resource. */ listTagsForResource(input: AWS.Keyspaces.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Restores the specified table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp. In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode, encryption, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted. You can also overwrite these settings during restore: • Read/write capacity mode • Provisioned throughput capacity settings • Point-in-time (PITR) settings • Tags For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide. Note that the following settings are not restored, and you must configure them manually for the new table: • Automatic scaling policies (for tables that use provisioned capacity mode) • Identity and Access Management (IAM) policies • Amazon CloudWatch metrics and alarms */ restoreTable(input: AWS.Keyspaces.RestoreTableRequest, options: SdkCallOptions): Promise; /** * Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide. For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide. */ tagResource(input: AWS.Keyspaces.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the association of tags from a Amazon Keyspaces resource. */ untagResource(input: AWS.Keyspaces.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation. */ updateTable(input: AWS.Keyspaces.UpdateTableRequest, options: SdkCallOptions): Promise; } export interface Kinesis { /** * Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream. If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys. AddTagsToStream has a limit of five transactions per second per account. */ addTagsToStream(input: AWS.Kinesis.AddTagsToStreamInput, options: SdkCallOptions): Promise<{}>; /** * Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream. You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards. The stream name identifies the stream. The name is scoped to the Amazon Web Services account used by the application. It is also scoped by Amazon Web Services Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name. CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream. You receive a LimitExceededException when making a CreateStream request when you try to do one of the following: Have more than five streams in the CREATING state at any point in time. Create more shards than are authorized for your account. For the default shard limit for an Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support. You can use DescribeStreamSummary to check the stream status, which is returned in StreamStatus. CreateStream has a limit of five transactions per second per account. */ createStream(input: AWS.Kinesis.CreateStreamInput, options: SdkCallOptions): Promise<{}>; /** * Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours. This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. */ decreaseStreamRetentionPeriod(input: AWS.Kinesis.DecreaseStreamRetentionPeriodInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException. If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion. Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete. When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream. You can use the DescribeStreamSummary operation to check the state of the stream, which is returned in StreamStatus. DeleteStream has a limit of five transactions per second per account. */ deleteStream(input: AWS.Kinesis.DeleteStreamInput, options: SdkCallOptions): Promise<{}>; /** * To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN. This operation has a limit of five transactions per second per stream. */ deregisterStreamConsumer(input: AWS.Kinesis.DeregisterStreamConsumerInput, options: SdkCallOptions): Promise<{}>; /** * Describes the shard limits and usage for the account. If you update your account limits, the old limits might be returned for a few minutes. This operation has a limit of one transaction per second per account. */ describeLimits(input: AWS.Kinesis.DescribeLimitsInput, options: SdkCallOptions): Promise; /** * Describes the specified Kinesis data stream. This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the specified Kinesis data stream and the ListShards API to list the shards in a specified data stream and obtain information about each shard. The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream. You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide. There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard. This operation has a limit of 10 transactions per second per account. */ describeStream(input: AWS.Kinesis.DescribeStreamInput, options: SdkCallOptions): Promise; /** * To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. This operation has a limit of 20 transactions per second per stream. */ describeStreamConsumer(input: AWS.Kinesis.DescribeStreamConsumerInput, options: SdkCallOptions): Promise; /** * Provides a summarized description of the specified Kinesis data stream without the shard list. The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count. DescribeStreamSummary has a limit of 20 transactions per second per account. */ describeStreamSummary(input: AWS.Kinesis.DescribeStreamSummaryInput, options: SdkCallOptions): Promise; /** * Disables enhanced monitoring. */ disableEnhancedMonitoring(input: AWS.Kinesis.DisableEnhancedMonitoringInput, options: SdkCallOptions): Promise; /** * Enables enhanced Kinesis data stream monitoring for shard-level metrics. */ enableEnhancedMonitoring(input: AWS.Kinesis.EnableEnhancedMonitoringInput, options: SdkCallOptions): Promise; /** * Gets data records from a Kinesis data stream's shard. Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records. You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process. Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000. The size of the data returned by GetRecords varies depending on the utilization of the shard. It is recommended that consumer applications retrieve records via the GetRecords command using the 5 TPS limit to remain caught up. Retrieving records less frequently can lead to consumer applications falling behind. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second. To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide). Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order. This operation has a limit of five transactions per second per shard. */ getRecords(input: AWS.Kinesis.GetRecordsInput, options: SdkCallOptions): Promise; /** * Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester. A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards. You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard. When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request. If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide. If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards. GetShardIterator has a limit of five transactions per second per account per open shard. */ getShardIterator(input: AWS.Kinesis.GetShardIteratorInput, options: SdkCallOptions): Promise; /** * Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours (365 days). If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications. */ increaseStreamRetentionPeriod(input: AWS.Kinesis.IncreaseStreamRetentionPeriodInput, options: SdkCallOptions): Promise<{}>; /** * Lists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream. This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard. This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM. */ listShards(input: AWS.Kinesis.ListShardsInput, options: SdkCallOptions): Promise; /** * Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer. This operation has a limit of 5 transactions per second per stream. */ listStreamConsumers(input: AWS.Kinesis.ListStreamConsumersInput, options: SdkCallOptions): Promise; /** * Lists your Kinesis data streams. The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 100. You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. ListStreams has a limit of five transactions per second per account. */ listStreams(input: AWS.Kinesis.ListStreamsInput, options: SdkCallOptions): Promise; /** * Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account. */ listTagsForStream(input: AWS.Kinesis.ListTagsForStreamInput, options: SdkCallOptions): Promise; /** * Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards. MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide. If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException. You can use DescribeStreamSummary to check the state of the stream, which is returned in StreamStatus. MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state. You use DescribeStreamSummary and the ListShards APIs to determine the shard IDs that are specified in the MergeShards request. If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException. MergeShards has a limit of five transactions per second per account. */ mergeShards(input: AWS.Kinesis.MergeShardsInput, options: SdkCallOptions): Promise<{}>; /** * Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself. The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs. Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record. Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. After you write a record to a stream, you cannot modify that record or its order within the stream. If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException. By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period. */ putRecord(input: AWS.Kinesis.PutRecordInput, options: SdkCallOptions): Promise; /** * Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing. Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob. The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide. The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array. The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead of PutRecords, and write to the same shard. A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide. After you write a record to a stream, you cannot modify that record or its order within the stream. By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period. */ putRecords(input: AWS.Kinesis.PutRecordsInput, options: SdkCallOptions): Promise; /** * Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream. You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time. For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API. The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException. */ registerStreamConsumer(input: AWS.Kinesis.RegisterStreamConsumerInput, options: SdkCallOptions): Promise; /** * Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes. If you specify a tag that does not exist, it is ignored. RemoveTagsFromStream has a limit of five transactions per second per account. */ removeTagsFromStream(input: AWS.Kinesis.RemoveTagsFromStreamInput, options: SdkCallOptions): Promise<{}>; /** * Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing. You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide. You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request. SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state. You can use DescribeStreamSummary to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If the specified stream does not exist, DescribeStreamSummary returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException. For the default shard limit for an Amazon Web Services account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support. If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException. SplitShard has a limit of five transactions per second per account. */ splitShard(input: AWS.Kinesis.SplitShardInput, options: SdkCallOptions): Promise<{}>; /** * Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream. Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream. API Limits: You can successfully apply a new Amazon Web Services KMS key for server-side encryption 25 times in a rolling 24-hour period. Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords. */ startStreamEncryption(input: AWS.Kinesis.StartStreamEncryptionInput, options: SdkCallOptions): Promise<{}>; /** * Disables server-side encryption for a specified stream. Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams. API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period. Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords. */ stopStreamEncryption(input: AWS.Kinesis.StopStreamEncryptionInput, options: SdkCallOptions): Promise<{}>; /** * Updates the shard count of the specified stream to the specified number of shards. Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING. To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. These short-lived shards count towards your total shard limit for your account in the Region. When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete. This operation has the following default limits. By default, you cannot do the following: Scale more than ten times per rolling 24-hour period per stream Scale up to more than double your current shard count for a stream Scale down below half your current shard count for a stream Scale up to more than 10000 shards in a stream Scale a stream with more than 10000 shards down unless the result is less than 10000 shards Scale up to more than the shard limit for your account For the default limits for an Amazon Web Services account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form. */ updateShardCount(input: AWS.Kinesis.UpdateShardCountInput, options: SdkCallOptions): Promise; /** * Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data stream. */ updateStreamMode(input: AWS.Kinesis.UpdateStreamModeInput, options: SdkCallOptions): Promise<{}>; } export interface KinesisAnalytics { /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs. */ addApplicationCloudWatchLoggingOption(input: AWS.KinesisAnalytics.AddApplicationCloudWatchLoggingOptionRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input. You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action. */ addApplicationInput(input: AWS.KinesisAnalytics.AddApplicationInputRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda. */ addApplicationInputProcessingConfiguration(input: AWS.KinesisAnalytics.AddApplicationInputProcessingConfigurationRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds an external destination to your Amazon Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. */ addApplicationOutput(input: AWS.KinesisAnalytics.AddApplicationOutputRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds a reference data source to an existing application. Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table. For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. */ addApplicationReferenceDataSource(input: AWS.KinesisAnalytics.AddApplicationReferenceDataSourceRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works. In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source. Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps. In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations. To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action. For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started. */ createApplication(input: AWS.KinesisAnalytics.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code). This operation requires permissions to perform the kinesisanalytics:DeleteApplication action. */ deleteApplication(input: AWS.KinesisAnalytics.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs. */ deleteApplicationCloudWatchLoggingOption(input: AWS.KinesisAnalytics.DeleteApplicationCloudWatchLoggingOptionRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes an InputProcessingConfiguration from an input. */ deleteApplicationInputProcessingConfiguration(input: AWS.KinesisAnalytics.DeleteApplicationInputProcessingConfigurationRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination. This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action. */ deleteApplicationOutput(input: AWS.KinesisAnalytics.DeleteApplicationOutputRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes a reference data source configuration from the specified application configuration. If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action. */ deleteApplicationReferenceDataSource(input: AWS.KinesisAnalytics.DeleteApplicationReferenceDataSourceRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Returns information about a specific Amazon Kinesis Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update. */ describeApplication(input: AWS.KinesisAnalytics.DescribeApplicationRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action. */ discoverInputSchema(input: AWS.KinesisAnalytics.DiscoverInputSchemaRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response. If you want detailed information about a specific application, use DescribeApplication. This operation requires permissions to perform the kinesisanalytics:ListApplications action. */ listApplications(input: AWS.KinesisAnalytics.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging. */ listTagsForResource(input: AWS.KinesisAnalytics.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application. After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination. The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation. After you start the application, you can stop the application from processing the input by calling the StopApplication operation. This operation requires permissions to perform the kinesisanalytics:StartApplication action. */ startApplication(input: AWS.KinesisAnalytics.StartApplicationRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination. This operation requires permissions to perform the kinesisanalytics:StopApplication action. */ stopApplication(input: AWS.KinesisAnalytics.StopApplicationRequest, options: SdkCallOptions): Promise; /** * Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging. */ tagResource(input: AWS.KinesisAnalytics.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging. */ untagResource(input: AWS.KinesisAnalytics.UntagResourceRequest, options: SdkCallOptions): Promise; /** * This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration. Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application. This operation requires permission for the kinesisanalytics:UpdateApplication action. */ updateApplication(input: AWS.KinesisAnalytics.UpdateApplicationRequest, options: SdkCallOptions): Promise; } export interface KinesisAnalyticsV2 { /** * Adds an Amazon CloudWatch log stream to monitor application configuration errors. */ addApplicationCloudWatchLoggingOption(input: AWS.KinesisAnalyticsV2.AddApplicationCloudWatchLoggingOptionRequest, options: SdkCallOptions): Promise; /** * Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. */ addApplicationInput(input: AWS.KinesisAnalyticsV2.AddApplicationInputRequest, options: SdkCallOptions): Promise; /** * Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is Amazon Lambda. */ addApplicationInputProcessingConfiguration(input: AWS.KinesisAnalyticsV2.AddApplicationInputProcessingConfigurationRequest, options: SdkCallOptions): Promise; /** * Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. */ addApplicationOutput(input: AWS.KinesisAnalyticsV2.AddApplicationOutputRequest, options: SdkCallOptions): Promise; /** * Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table. */ addApplicationReferenceDataSource(input: AWS.KinesisAnalyticsV2.AddApplicationReferenceDataSourceRequest, options: SdkCallOptions): Promise; /** * Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely. Note the following about VPC configurations for Kinesis Data Analytics applications: VPC configurations are not supported for SQL applications. When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC. */ addApplicationVpcConfiguration(input: AWS.KinesisAnalyticsV2.AddApplicationVpcConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application. */ createApplication(input: AWS.KinesisAnalyticsV2.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Creates and returns a URL that you can use to connect to an application's extension. Currently, the only available extension is the Apache Flink dashboard. The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request that attempts to connect to the extension. You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds parameter. If you do not provide this parameter, the returned URL is valid for twelve hours. The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error. */ createApplicationPresignedUrl(input: AWS.KinesisAnalyticsV2.CreateApplicationPresignedUrlRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of the application's state data. */ createApplicationSnapshot(input: AWS.KinesisAnalyticsV2.CreateApplicationSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application. */ deleteApplication(input: AWS.KinesisAnalyticsV2.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application. */ deleteApplicationCloudWatchLoggingOption(input: AWS.KinesisAnalyticsV2.DeleteApplicationCloudWatchLoggingOptionRequest, options: SdkCallOptions): Promise; /** * Deletes an InputProcessingConfiguration from an input. */ deleteApplicationInputProcessingConfiguration(input: AWS.KinesisAnalyticsV2.DeleteApplicationInputProcessingConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination. */ deleteApplicationOutput(input: AWS.KinesisAnalyticsV2.DeleteApplicationOutputRequest, options: SdkCallOptions): Promise; /** * Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. */ deleteApplicationReferenceDataSource(input: AWS.KinesisAnalyticsV2.DeleteApplicationReferenceDataSourceRequest, options: SdkCallOptions): Promise; /** * Deletes a snapshot of application state. */ deleteApplicationSnapshot(input: AWS.KinesisAnalyticsV2.DeleteApplicationSnapshotRequest, options: SdkCallOptions): Promise; /** * Removes a VPC configuration from a Kinesis Data Analytics application. */ deleteApplicationVpcConfiguration(input: AWS.KinesisAnalyticsV2.DeleteApplicationVpcConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. */ describeApplication(input: AWS.KinesisAnalyticsV2.DescribeApplicationRequest, options: SdkCallOptions): Promise; /** * Returns information about a snapshot of application state data. */ describeApplicationSnapshot(input: AWS.KinesisAnalyticsV2.DescribeApplicationSnapshotRequest, options: SdkCallOptions): Promise; /** * Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation. This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink. */ describeApplicationVersion(input: AWS.KinesisAnalyticsV2.DescribeApplicationVersionRequest, options: SdkCallOptions): Promise; /** * Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface. */ discoverInputSchema(input: AWS.KinesisAnalyticsV2.DiscoverInputSchemaRequest, options: SdkCallOptions): Promise; /** * Lists information about the current application snapshots. */ listApplicationSnapshots(input: AWS.KinesisAnalyticsV2.ListApplicationSnapshotsRequest, options: SdkCallOptions): Promise; /** * Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version. To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation. This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink. */ listApplicationVersions(input: AWS.KinesisAnalyticsV2.ListApplicationVersionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication. */ listApplications(input: AWS.KinesisAnalyticsV2.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging. */ listTagsForResource(input: AWS.KinesisAnalyticsV2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status. You can roll back an application only if it is in the UPDATING or AUTOSCALING status. When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Kinesis Data Analytics rejects the rollback request. This action is not supported for Kinesis Data Analytics for SQL applications. */ rollbackApplication(input: AWS.KinesisAnalyticsV2.RollbackApplicationRequest, options: SdkCallOptions): Promise; /** * Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application. */ startApplication(input: AWS.KinesisAnalyticsV2.StartApplicationRequest, options: SdkCallOptions): Promise; /** * Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true. You can use the DescribeApplication operation to find the application status. Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force is set to true. */ stopApplication(input: AWS.KinesisAnalyticsV2.StopApplicationRequest, options: SdkCallOptions): Promise; /** * Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging. */ tagResource(input: AWS.KinesisAnalyticsV2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging. */ untagResource(input: AWS.KinesisAnalyticsV2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application. You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment, you must delete the application and create it again. */ updateApplication(input: AWS.KinesisAnalyticsV2.UpdateApplicationRequest, options: SdkCallOptions): Promise; /** * Updates the maintenance configuration of the Kinesis Data Analytics application. You can invoke this operation on an application that is in one of the two following states: READY or RUNNING. If you invoke it when the application is in a state other than these two states, it throws a ResourceInUseException. The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead. To see the current maintenance configuration of your application, invoke the DescribeApplication operation. For information about application maintenance, see Kinesis Data Analytics for Apache Flink Maintenance. This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink. */ updateApplicationMaintenanceConfiguration(input: AWS.KinesisAnalyticsV2.UpdateApplicationMaintenanceConfigurationRequest, options: SdkCallOptions): Promise; } export interface KinesisVideo { /** * Creates a signaling channel. CreateSignalingChannel is an asynchronous operation. */ createSignalingChannel(input: AWS.KinesisVideo.CreateSignalingChannelInput, options: SdkCallOptions): Promise; /** * Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version. CreateStream is an asynchronous operation. For information about how the service works, see How it Works. You must have permissions for the KinesisVideo:CreateStream action. */ createStream(input: AWS.KinesisVideo.CreateStreamInput, options: SdkCallOptions): Promise; /** * Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted. */ deleteSignalingChannel(input: AWS.KinesisVideo.DeleteSignalingChannelInput, options: SdkCallOptions): Promise; /** * Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream for deletion, and makes the data in the stream inaccessible immediately. To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. This operation requires permission for the KinesisVideo:DeleteStream action. */ deleteStream(input: AWS.KinesisVideo.DeleteStreamInput, options: SdkCallOptions): Promise; /** * Gets the ImageGenerationConfiguration for a given Kinesis video stream. */ describeImageGenerationConfiguration(input: AWS.KinesisVideo.DescribeImageGenerationConfigurationInput, options: SdkCallOptions): Promise; /** * Gets the NotificationConfiguration for a given Kinesis video stream. */ describeNotificationConfiguration(input: AWS.KinesisVideo.DescribeNotificationConfigurationInput, options: SdkCallOptions): Promise; /** * Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe. */ describeSignalingChannel(input: AWS.KinesisVideo.DescribeSignalingChannelInput, options: SdkCallOptions): Promise; /** * Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN. */ describeStream(input: AWS.KinesisVideo.DescribeStreamInput, options: SdkCallOptions): Promise; /** * Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation). The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint. In the request, specify the stream either by StreamName or StreamARN. */ getDataEndpoint(input: AWS.KinesisVideo.GetDataEndpointInput, options: SdkCallOptions): Promise; /** * Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties. Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint. Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER. */ getSignalingChannelEndpoint(input: AWS.KinesisVideo.GetSignalingChannelEndpointInput, options: SdkCallOptions): Promise; /** * Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition. */ listSignalingChannels(input: AWS.KinesisVideo.ListSignalingChannelsInput, options: SdkCallOptions): Promise; /** * Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition. */ listStreams(input: AWS.KinesisVideo.ListStreamsInput, options: SdkCallOptions): Promise; /** * Returns a list of tags associated with the specified signaling channel. */ listTagsForResource(input: AWS.KinesisVideo.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN. */ listTagsForStream(input: AWS.KinesisVideo.ListTagsForStreamInput, options: SdkCallOptions): Promise; /** * Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide. */ tagResource(input: AWS.KinesisVideo.TagResourceInput, options: SdkCallOptions): Promise; /** * Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide. You must provide either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:TagStream action. A Kinesis video stream can support up to 50 tags. */ tagStream(input: AWS.KinesisVideo.TagStreamInput, options: SdkCallOptions): Promise; /** * Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. */ untagResource(input: AWS.KinesisVideo.UntagResourceInput, options: SdkCallOptions): Promise; /** * Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the StreamName or StreamARN. */ untagStream(input: AWS.KinesisVideo.UntagStreamInput, options: SdkCallOptions): Promise; /** * Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN. The retention period that you specify replaces the current value. This operation requires permission for the KinesisVideo:UpdateDataRetention action. Changing the data retention period affects the data in the stream as follows: If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours. If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately. */ updateDataRetention(input: AWS.KinesisVideo.UpdateDataRetentionInput, options: SdkCallOptions): Promise; /** * Updates the StreamInfo and ImageProcessingConfiguration fields. */ updateImageGenerationConfiguration(input: AWS.KinesisVideo.UpdateImageGenerationConfigurationInput, options: SdkCallOptions): Promise; /** * Updates the notification information for a stream. */ updateNotificationConfiguration(input: AWS.KinesisVideo.UpdateNotificationConfigurationInput, options: SdkCallOptions): Promise; /** * Updates the existing signaling channel. This is an asynchronous operation and takes time to complete. If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value. */ updateSignalingChannel(input: AWS.KinesisVideo.UpdateSignalingChannelInput, options: SdkCallOptions): Promise; /** * Updates stream metadata, such as the device name and media type. You must provide the stream name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. UpdateStream is an asynchronous operation, and takes time to complete. */ updateStream(input: AWS.KinesisVideo.UpdateStreamInput, options: SdkCallOptions): Promise; } export interface KinesisVideoArchivedMedia { /** * Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the specified time range. Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation. As a prerequisite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint, specifying GET_CLIP for the APIName parameter. An Amazon Kinesis video stream has the following requirements for providing data through MP4: The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711). Data retention must be greater than 0. The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see MPEG-4 specification ISO/IEC 14496-15. For information about adapting stream data to a given format, see NAL Adaptation Flags. The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format. You can monitor the amount of outgoing data by monitoring the GetClip.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for outgoing AWS data apply. */ getClip(input: AWS.KinesisVideoArchivedMedia.GetClipInput, options: SdkCallOptions): Promise; /** * Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can then open the URL in a media player to view the stream contents. Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation. An Amazon Kinesis video stream has the following requirements for providing data through MPEG-DASH: The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711). Data retention must be greater than 0. The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see MPEG-4 specification ISO/IEC 14496-15. For information about adapting stream data to a given format, see NAL Adaptation Flags. The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format. The following procedure shows how to use MPEG-DASH with Kinesis Video Streams: Get an endpoint using GetDataEndpoint, specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter. Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL. Kinesis Video Streams creates an MPEG-DASH streaming session to be used for accessing content in a stream using the MPEG-DASH protocol. GetDASHStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's MPEG-DASH manifest (the root resource needed for streaming with MPEG-DASH). Don't share or store this token where an unauthorized entity can access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you use with your AWS credentials. The media that is made available through the manifest consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available. Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization fragment and media fragments available through the manifest URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded video frames or encoded audio samples. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions: GetDASHManifest: Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want to playback. GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames. GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video. Data retrieved with this action is billable. See Pricing for details. For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits. You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply. For more information about HLS, see HTTP Live Streaming on the Apple Developer site. If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. For more information, see the Errors section at the bottom of this topic, as well as Common Errors. */ getDASHStreamingSessionURL(input: AWS.KinesisVideoArchivedMedia.GetDASHStreamingSessionURLInput, options: SdkCallOptions): Promise; /** * Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents. Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation. An Amazon Kinesis video stream has the following requirements for providing data through HLS: The media must contain h.264 or h.265 encoded video and, optionally, AAC encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEG/ISO/HEVC (for h.265). Optionally, the codec ID of track 2 should be A_AAC. Data retention must be greater than 0. The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags. The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7). Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification. The following procedure shows how to use HLS with Kinesis Video Streams: Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS). Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials. The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions: GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action for each track, and additional metadata for the media player, including estimated bitrate and resolution. GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track. GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames. GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video. Data retrieved with this action is billable. See Pricing for details. GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream. If the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve stream media. Data retrieved with this action is billable. For more information, see Kinesis Video Streams pricing. A streaming session URL must not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits. You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply. For more information about HLS, see HTTP Live Streaming on the Apple Developer site. If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. For more information, see the Errors section at the bottom of this topic, as well as Common Errors. */ getHLSStreamingSessionURL(input: AWS.KinesisVideoArchivedMedia.GetHLSStreamingSessionURLInput, options: SdkCallOptions): Promise; /** * Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration. */ getImages(input: AWS.KinesisVideoArchivedMedia.GetImagesInput, options: SdkCallOptions): Promise; /** * Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter. For limits, see Kinesis Video Streams Limits. If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. For more information, see the Errors section at the bottom of this topic, as well as Common Errors. */ getMediaForFragmentList(input: AWS.KinesisVideoArchivedMedia.GetMediaForFragmentListInput, options: SdkCallOptions): Promise; /** * Returns a list of Fragment objects from the specified stream and timestamp range within the archived data. Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second. You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the --endpoint-url parameter. If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. For more information, see the Errors section at the bottom of this topic, as well as Common Errors. */ listFragments(input: AWS.KinesisVideoArchivedMedia.ListFragmentsInput, options: SdkCallOptions): Promise; } export interface KinesisVideoMedia { /** * Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter. When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see PutMedia. The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request. The following limits apply when using the GetMedia API: A client can call GetMedia up to five times per second per stream. Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session. If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. For more information, see the Errors section at the bottom of this topic, as well as Common Errors. */ getMedia(input: AWS.KinesisVideoMedia.GetMediaInput, options: SdkCallOptions): Promise; } export interface KinesisVideoSignalingChannels { /** * Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server. TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services. You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API. */ getIceServerConfig(input: AWS.KinesisVideoSignalingChannels.GetIceServerConfigRequest, options: SdkCallOptions): Promise; /** * This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires. */ sendAlexaOfferToMaster(input: AWS.KinesisVideoSignalingChannels.SendAlexaOfferToMasterRequest, options: SdkCallOptions): Promise; } export interface KMS { /** * Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS key is Disabled. To enable the KMS key, use EnableKey. For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:CancelKeyDeletion (key policy) Related operations: ScheduleKeyDeletion */ cancelKeyDeletion(input: AWS.KMS.CancelKeyDeletionRequest, options: SdkCallOptions): Promise; /** * Connects or reconnects a custom key store to its associated CloudHSM cluster. The custom key store must be connected before you can create KMS keys in the key store or use the KMS keys it contains. You can disconnect and reconnect a custom key store at any time. To connect a custom key store, its associated CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. Also, the kmsuser crypto user (CU) must not be logged into the cluster. This prevents KMS from using this account to log in. The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation. During the connection process, KMS finds the CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the CloudHSM client as the kmsuser CU, and rotates its password. The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry. To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again. If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. Required permissions: kms:ConnectCustomKeyStore (IAM policy) Related operations CreateCustomKeyStore DeleteCustomKeyStore DescribeCustomKeyStores DisconnectCustomKeyStore UpdateCustomKeyStore */ connectCustomKeyStore(input: AWS.KMS.ConnectCustomKeyStoreRequest, options: SdkCallOptions): Promise; /** * Creates a friendly name for a KMS key. Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide. You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and GenerateDataKey. You can also change the KMS key that's associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don't affect the underlying KMS key. You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an alias without a KMS key. The alias must be unique in the account and Region, but you can have aliases with the same name in different Regions. For detailed information about aliases, see Using aliases in the Key Management Service Developer Guide. This operation does not return a response. To get the alias that you created, use the ListAliases operation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account. Required permissions kms:CreateAlias on the alias (IAM policy). kms:CreateAlias on the KMS key (key policy). For details, see Controlling access to aliases in the Key Management Service Developer Guide. Related operations: DeleteAlias ListAliases UpdateAlias */ createAlias(input: AWS.KMS.CreateAliasRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a custom key store that is associated with an CloudHSM cluster that you own and manage. This operation is part of the custom key store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store. Before you create the custom key store, you must assemble the required elements, including an CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the Key Management Service Developer Guide. When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it. For help with failures, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. Required permissions: kms:CreateCustomKeyStore (IAM policy). Related operations: ConnectCustomKeyStore DeleteCustomKeyStore DescribeCustomKeyStores DisconnectCustomKeyStore UpdateCustomKeyStore */ createCustomKeyStore(input: AWS.KMS.CreateCustomKeyStoreRequest, options: SdkCallOptions): Promise; /** * Adds a grant to a KMS key. A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants. The CreateGrant operation returns a GrantToken and a GrantId. When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant. However, to use the permissions in the grant immediately, use the GrantToken that CreateGrant returns. For details, see Using a grant token in the Key Management Service Developer Guide . The CreateGrant operation also returns a GrantId. You can use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, use the ListGrants or ListRetirableGrants operations. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:CreateGrant (key policy) Related operations: ListGrants ListRetirableGrants RetireGrant RevokeGrant */ createGrant(input: AWS.KMS.CreateGrantRequest, options: SdkCallOptions): Promise; /** * Creates a unique customer managed KMS key in your Amazon Web Services account and Region. In addition to the required parameters, you can use the optional parameters to specify a key policy, description, tags, and other useful elements for any key type. KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term. To create different types of KMS keys, use the following guidance: Symmetric encryption KMS key To create a symmetric encryption KMS key, you aren't required to specify any parameters. The default value for KeySpec, SYMMETRIC_DEFAULT, and the default value for KeyUsage, ENCRYPT_DECRYPT, create a symmetric encryption KMS key. For technical details, see SYMMETRIC_DEFAULT key spec in the Key Management Service Developer Guide. If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair. Asymmetric KMS keys To create an asymmetric KMS key, use the KeySpec parameter to specify the type of key material in the KMS key. Then, use the KeyUsage parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created. Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or an SM2 key pair (China Regions only). The private key in an asymmetric KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of KMS. KMS keys with RSA or SM2 key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key pairs can be used only to sign and verify messages. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. HMAC KMS key To create an HMAC KMS key, set the KeySpec parameter to a key spec value for HMAC KMS keys. Then set the KeyUsage parameter to GENERATE_VERIFY_MAC. You must set the key usage even though GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created. HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes. HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the CreateKey operation returns an UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide. Multi-Region primary keys Imported key material To create a multi-Region primary key in the local Amazon Web Services Region, use the MultiRegion parameter with a value of True. To create a multi-Region replica key, that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion operation. You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store. This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. To import your own key material, begin by creating a symmetric encryption KMS key with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the Key Management Service Developer Guide . This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key material into any other type of KMS key. To create a multi-Region primary key with imported key material, use the Origin parameter of CreateKey with a value of EXTERNAL and the MultiRegion parameter with a value of True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. Custom key store To create a symmetric encryption KMS key in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region. Custom key stores support only symmetric encryption KMS keys. You cannot create an HMAC KMS key or an asymmetric KMS key in a custom key store. For information about custom key stores in KMS see Custom key stores in KMS in the Key Management Service Developer Guide . Cross-account use: No. You cannot use this operation to create a KMS key in a different Amazon Web Services account. Required permissions: kms:CreateKey (IAM policy). To use the Tags parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide. Related operations: DescribeKey ListKeys ScheduleKeyDeletion */ createKey(input: AWS.KMS.CreateKeyRequest, options: SdkCallOptions): Promise; /** * Decrypts ciphertext that was encrypted by a KMS key using any of the following operations: Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext GenerateDataKeyPairWithoutPlaintext You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS. If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend. Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide. Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:Decrypt (key policy) Related operations: Encrypt GenerateDataKey GenerateDataKeyPair ReEncrypt */ decrypt(input: AWS.KMS.DecryptRequest, options: SdkCallOptions): Promise; /** * Deletes the specified alias. Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide. Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation. Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias. Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account. Required permissions kms:DeleteAlias on the alias (IAM policy). kms:DeleteAlias on the KMS key (key policy). For details, see Controlling access to aliases in the Key Management Service Developer Guide. Related operations: CreateAlias ListAliases UpdateAlias */ deleteAlias(input: AWS.KMS.DeleteAliasRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a custom key store. This operation does not delete the CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster. The custom key store that you delete cannot contain any KMS keys. Before deleting the key store, verify that you will never need to use any of the KMS keys in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the KMS keys from the key store. When the scheduled waiting period expires, the ScheduleKeyDeletion operation deletes the KMS keys. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. After all KMS keys are deleted from KMS, use DisconnectCustomKeyStore to disconnect the key store from KMS. Then, you can delete the custom key store. Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from KMS. While the key store is disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to delete KMS keys and you can reconnect a disconnected custom key store at any time. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the custom key store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store. Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. Required permissions: kms:DeleteCustomKeyStore (IAM policy) Related operations: ConnectCustomKeyStore CreateCustomKeyStore DescribeCustomKeyStores DisconnectCustomKeyStore UpdateCustomKeyStore */ deleteCustomKeyStore(input: AWS.KMS.DeleteCustomKeyStoreRequest, options: SdkCallOptions): Promise; /** * Deletes key material that you previously imported. This operation makes the specified KMS key unusable. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. When the specified KMS key is in the PendingDeletion state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to PendingImport. After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the KMS key. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:DeleteImportedKeyMaterial (key policy) Related operations: GetParametersForImport ImportKeyMaterial */ deleteImportedKeyMaterial(input: AWS.KMS.DeleteImportedKeyMaterialRequest, options: SdkCallOptions): Promise<{}>; /** * Gets information about custom key stores in the account and Region. This operation is part of the custom key store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store. By default, this operation returns information about all custom key stores in the account and Region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both). To determine whether the custom key store is connected to its CloudHSM cluster, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry. Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any. For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. Required permissions: kms:DescribeCustomKeyStores (IAM policy) Related operations: ConnectCustomKeyStore CreateCustomKeyStore DeleteCustomKeyStore DisconnectCustomKeyStore UpdateCustomKeyStore */ describeCustomKeyStores(input: AWS.KMS.DescribeCustomKeyStoresRequest, options: SdkCallOptions): Promise; /** * Provides detailed information about a KMS key. You can run DescribeKey on a customer managed key or an Amazon Web Services managed key. This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. It includes fields, like KeySpec, that help you distinguish different types of KMS keys. It also displays the key usage (encryption, signing, or generating and verifying MACs) and the algorithms that the KMS key supports. For KMS keys in custom key stores, it includes information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For multi-Region keys, it displays the primary key and all related replica keys. DescribeKey does not return the following information: Aliases associated with the KMS key. To get this information, use ListAliases. Whether automatic key rotation is enabled on the KMS key. To get this information, use GetKeyRotationStatus. Also, some key states prevent a KMS key from being automatically rotated. For details, see How Automatic Key Rotation Works in the Key Management Service Developer Guide. Tags on the KMS key. To get this information, use ListResourceTags. Key policies and grants on the KMS key. To get this information, use GetKeyPolicy and ListGrants. In general, DescribeKey is a non-mutating operation. It returns data about KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to create Amazon Web Services managed keys from a predefined Amazon Web Services alias with no key ID. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:DescribeKey (key policy) Related operations: GetKeyPolicy GetKeyRotationStatus ListAliases ListGrants ListKeys ListResourceTags ListRetirableGrants */ describeKey(input: AWS.KMS.DescribeKeyRequest, options: SdkCallOptions): Promise; /** * Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS key for cryptographic operations. For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide . The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:DisableKey (key policy) Related operations: EnableKey */ disableKey(input: AWS.KMS.DisableKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Disables automatic rotation of the key material of the specified symmetric encryption KMS key. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:DisableKeyRotation (key policy) Related operations: EnableKeyRotation GetKeyRotationStatus */ disableKeyRotation(input: AWS.KMS.DisableKeyRotationRequest, options: SdkCallOptions): Promise<{}>; /** * Disconnects the custom key store from its associated CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use KMS keys in the custom key store. You can reconnect the custom key store at any time. While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the custom key store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store. Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. Required permissions: kms:DisconnectCustomKeyStore (IAM policy) Related operations: ConnectCustomKeyStore CreateCustomKeyStore DeleteCustomKeyStore DescribeCustomKeyStores UpdateCustomKeyStore */ disconnectCustomKeyStore(input: AWS.KMS.DisconnectCustomKeyStoreRequest, options: SdkCallOptions): Promise; /** * Sets the key state of a KMS key to enabled. This allows you to use the KMS key for cryptographic operations. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:EnableKey (key policy) Related operations: DisableKey */ enableKey(input: AWS.KMS.EnableKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Enables automatic rotation of the key material of the specified symmetric encryption KMS key. When you enable automatic rotation of acustomer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days). New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter. Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:EnableKeyRotation (key policy) Related operations: DisableKeyRotation GetKeyRotationStatus */ enableKeyRotation(input: AWS.KMS.EnableKeyRotationRequest, options: SdkCallOptions): Promise<{}>; /** * Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT. You can use this operation to encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key. If you use a symmetric encryption KMS key, you can use an encryption context to add additional security to your encryption operation. If you specify an EncryptionContext when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide. If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The algorithm must be compatible with the KMS key spec. When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails. You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields. The maximum size of the data that you can encrypt varies with the type of KMS key and the encryption algorithm that you choose. Symmetric encryption KMS keys SYMMETRIC_DEFAULT: 4096 bytes RSA_2048 RSAES_OAEP_SHA_1: 214 bytes RSAES_OAEP_SHA_256: 190 bytes RSA_3072 RSAES_OAEP_SHA_1: 342 bytes RSAES_OAEP_SHA_256: 318 bytes RSA_4096 RSAES_OAEP_SHA_1: 470 bytes RSAES_OAEP_SHA_256: 446 bytes SM2PKE: 1024 bytes (China Regions only) The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:Encrypt (key policy) Related operations: Decrypt GenerateDataKey GenerateDataKeyPair */ encrypt(input: AWS.KMS.EncryptRequest, options: SdkCallOptions): Promise; /** * Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data. To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation. You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter. To generate an SM4 data key (China Regions only), specify a KeySpec value of AES_128 or NumberOfBytes value of 128. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key. To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom. You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide. Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. How to use your data key We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you. To encrypt data outside of KMS: Use the GenerateDataKey operation to get a data key. Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory. Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data. To decrypt data outside of KMS: Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key. Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateDataKey (key policy) Related operations: Decrypt Encrypt GenerateDataKeyPair GenerateDataKeyPairWithoutPlaintext GenerateDataKeyWithoutPlaintext */ generateDataKey(input: AWS.KMS.GenerateDataKeyRequest, options: SdkCallOptions): Promise; /** * Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they not related to the caller or to the KMS key that is used to encrypt the private key. You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation. Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS. If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair. GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. The private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958. You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateDataKeyPair (key policy) Related operations: Decrypt Encrypt GenerateDataKey GenerateDataKeyPairWithoutPlaintext GenerateDataKeyWithoutPlaintext */ generateDataKeyPair(input: AWS.KMS.GenerateDataKeyPairRequest, options: SdkCallOptions): Promise; /** * Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key. You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation. Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS. GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy) Related operations: Decrypt Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext */ generateDataKeyPairWithoutPlaintext(input: AWS.KMS.GenerateDataKeyPairWithoutPlaintextRequest, options: SdkCallOptions): Promise; /** * Returns a unique symmetric data key for use outside of KMS. This operation returns a data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the key are random; they are not related to the caller or to the KMS key. GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key. It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations. To generate a data key, you must specify the symmetric encryption KMS key that is used to encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the type of your KMS key, use the DescribeKey operation. If the operation succeeds, you will find the encrypted copy of the data key in the CiphertextBlob field. You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy) Related operations: Decrypt Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyPairWithoutPlaintext */ generateDataKeyWithoutPlaintext(input: AWS.KMS.GenerateDataKeyWithoutPlaintextRequest, options: SdkCallOptions): Promise; /** * Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104. You can use the HMAC that this operation generates with the VerifyMac operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide . Best practices recommend that you limit the time during which any signing mechanism, including an HMAC, is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. HMAC tags do not include a timestamp, but you can include a timestamp in the token or message to help you detect when its time to refresh the HMAC. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateMac (key policy) Related operations: VerifyMac */ generateMac(input: AWS.KMS.GenerateMacRequest, options: SdkCallOptions): Promise; /** * Returns a random byte string that is cryptographically secure. You must use the NumberOfBytes parameter to specify the length of the random byte string. There is no default value for string length. By default, the random byte string is generated in KMS. To generate the byte string in the CloudHSM cluster that is associated with a custom key store, specify the custom key store ID. Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide. For more information about entropy and random number generation, see Key Management Service Cryptographic Details. Cross-account use: Not applicable. GenerateRandom does not use any account-specific resources, such as KMS keys. Required permissions: kms:GenerateRandom (IAM policy) */ generateRandom(input: AWS.KMS.GenerateRandomRequest, options: SdkCallOptions): Promise; /** * Gets a key policy attached to the specified KMS key. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:GetKeyPolicy (key policy) Related operations: PutKeyPolicy */ getKeyPolicy(input: AWS.KMS.GetKeyPolicyRequest, options: SdkCallOptions): Promise; /** * Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key. When you enable automatic rotation for customer managed KMS keys, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.. You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule. Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:GetKeyRotationStatus (key policy) Related operations: DisableKeyRotation EnableKeyRotation */ getKeyRotationStatus(input: AWS.KMS.GetKeyRotationStatusRequest, options: SdkCallOptions): Promise; /** * Returns the items you need to import key material into a symmetric encryption KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide. This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request. You must specify the key ID of the symmetric encryption KMS key into which you will import key material. This KMS key's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:GetParametersForImport (key policy) Related operations: ImportKeyMaterial DeleteImportedKeyMaterial */ getParametersForImport(input: AWS.KMS.GetParametersForImportRequest, options: SdkCallOptions): Promise; /** * Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric KMS key. You can share the public key to allow others to encrypt messages and verify signatures outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. You do not need to download the public key. Instead, you can use the public key within KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric KMS key. When you use the public key within KMS, you benefit from the authentication, authorization, and logging that are part of every KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of KMS. To verify a signature outside of KMS with an SM2 public key (China Regions only), you must specify the distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing ID. For more information, see Offline verification with SM2 key pairs. To help you use the public key safely outside of KMS, GetPublicKey returns important information about the public key in the response, including: KeySpec: The type of key material in the public key, such as RSA_4096 or ECC_NIST_P521. KeyUsage: Whether the key is used for encryption or signing. EncryptionAlgorithms or SigningAlgorithms: A list of the encryption algorithms or the signing algorithms for the key. Although KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GetPublicKey (key policy) Related operations: CreateKey */ getPublicKey(input: AWS.KMS.GetPublicKeyRequest, options: SdkCallOptions): Promise; /** * Imports key material into an existing symmetric encryption KMS key that was created without key material. After you successfully import key material into a KMS key, you can reimport the same key material into that KMS key, but you cannot import different key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material and then importing key material, see Importing Key Material in the Key Management Service Developer Guide. Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response. When calling this operation, you must specify the following values: The key ID or key ARN of a KMS key with no key material. Its Origin must be EXTERNAL. To create a KMS key with no key material, call CreateKey and set the value of its Origin parameter to EXTERNAL. To get the Origin of a KMS key, call DescribeKey.) The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport. The import token that GetParametersForImport returned. You must use a public key and token from the same GetParametersForImport response. Whether the key material expires and if so, when. If you set an expiration date, KMS deletes the key material from the KMS key on the specified date, and the KMS key becomes unusable. To use the KMS key again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date. When this operation is successful, the key state of the KMS key changes from PendingImport to Enabled, and you can use the KMS key. If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key and repeat the import procedure. For help, see How To Import Key Material in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:ImportKeyMaterial (key policy) Related operations: DeleteImportedKeyMaterial GetParametersForImport */ importKeyMaterial(input: AWS.KMS.ImportKeyMaterialRequest, options: SdkCallOptions): Promise; /** * Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about aliases, see CreateAlias. By default, the ListAliases operation returns all aliases in the account and region. To get only the aliases associated with a particular KMS key, use the KeyId parameter. The ListAliases response can include aliases that you created and associated with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services managed keys in your account. You can recognize Amazon Web Services aliases because their names have the format aws/<service-name>, such as aws/dynamodb. The response might also include aliases that have no TargetKeyId field. These are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against your KMS aliases quota. Cross-account use: No. ListAliases does not return aliases in other Amazon Web Services accounts. Required permissions: kms:ListAliases (IAM policy) For details, see Controlling access to aliases in the Key Management Service Developer Guide. Related operations: CreateAlias DeleteAlias UpdateAlias */ listAliases(input: AWS.KMS.ListAliasesRequest, options: SdkCallOptions): Promise; /** * Gets a list of all grants for the specified KMS key. You must specify the KMS key in all requests. You can filter the grant list by grant ID or grantee principal. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants. The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:ListGrants (key policy) Related operations: CreateGrant ListRetirableGrants RetireGrant RevokeGrant */ listGrants(input: AWS.KMS.ListGrantsRequest, options: SdkCallOptions): Promise; /** * Gets the names of the key policies that are attached to a KMS key. This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:ListKeyPolicies (key policy) Related operations: GetKeyPolicy PutKeyPolicy */ listKeyPolicies(input: AWS.KMS.ListKeyPoliciesRequest, options: SdkCallOptions): Promise; /** * Gets a list of all KMS keys in the caller's Amazon Web Services account and Region. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:ListKeys (IAM policy) Related operations: CreateKey DescribeKey ListAliases ListResourceTags */ listKeys(input: AWS.KMS.ListKeysRequest, options: SdkCallOptions): Promise; /** * Returns all tags on the specified KMS key. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. For information about using tags in KMS, see Tagging keys. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:ListResourceTags (key policy) Related operations: CreateKey ReplicateKey TagResource UntagResource */ listResourceTags(input: AWS.KMS.ListResourceTagsRequest, options: SdkCallOptions): Promise; /** * Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal. You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants. Cross-account use: You must specify a principal in your Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need kms:ListRetirableGrants permission (or any other additional permission) in any Amazon Web Services account other than your own. Required permissions: kms:ListRetirableGrants (IAM policy) in your Amazon Web Services account. Related operations: CreateGrant ListGrants RetireGrant RevokeGrant */ listRetirableGrants(input: AWS.KMS.ListRetirableGrantsRequest, options: SdkCallOptions): Promise; /** * Attaches a key policy to the specified KMS key. For more information about key policies, see Key Policies in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide . For examples of adding a key policy in multiple programming languages, see Setting a key policy in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:PutKeyPolicy (key policy) Related operations: GetKeyPolicy */ putKeyPolicy(input: AWS.KMS.PutKeyPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this operation to change the KMS key under which data is encrypted, such as when you manually rotate a KMS key or change the KMS key that protects a ciphertext. You can also use it to reencrypt ciphertext under the same KMS key, such as to change the encryption context of a ciphertext. The ReEncrypt operation can decrypt ciphertext that was encrypted by using a KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric KMS key outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS. When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation. If your ciphertext was encrypted under an asymmetric KMS key, you must use the SourceKeyId parameter to identify the KMS key that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data. If your ciphertext was encrypted under a symmetric encryption KMS key, the SourceKeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the source KMS key is always recommended as a best practice. When you use the SourceKeyId parameter to specify a KMS key, KMS uses only the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the ReEncrypt operation fails. This practice ensures that you use the KMS key that you intend. To reencrypt the data, you must use the DestinationKeyId parameter specify the KMS key that re-encrypts the data after it is decrypted. If the destination KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the KMS key. When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails. You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a different account than the caller. To specify a KMS key in a different account, you must use its key ARN or alias ARN. Required permissions: kms:ReEncryptFrom permission on the source KMS key (key policy) kms:ReEncryptTo permission on the destination KMS key (key policy) To permit reencryption from or to a KMS key, include the "kms:ReEncrypt*" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a KMS key. But you must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy. Related operations: Decrypt Encrypt GenerateDataKey GenerateDataKeyPair */ reEncrypt(input: AWS.KMS.ReEncryptRequest, options: SdkCallOptions): Promise; /** * Replicates a multi-Region key into the specified Region. This operation creates a multi-Region replica key based on a multi-Region primary key in a different Region of the same Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a different Region. To create a multi-Region primary key, use the CreateKey operation. This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. A replica key is a fully-functional KMS key that can be used independently of its primary and peer replica keys. A primary key and its replica keys share properties that make them interoperable. They have the same key ID and key material. They also have the same key spec, key usage, key material origin, and automatic key rotation status. KMS automatically synchronizes these shared properties among related multi-Region keys. All other properties of a replica key can differ, including its key policy, tags, aliases, and Key states of KMS keys. KMS pricing and quotas for KMS keys apply to each primary key and replica key. When this operation completes, the new replica key has a transient key state of Creating. This key state changes to Enabled (or PendingImport) after a few seconds when the process of creating the new replica key is complete. While the key state is Creating, you can manage key, but you cannot yet use it in cryptographic operations. If you are creating and using the replica key programmatically, retry on KMSInvalidStateException or call DescribeKey to check its KeyState value before using it. For details about the Creating key state, see Key states of KMS keys in the Key Management Service Developer Guide. You cannot create more than one replica of a primary key in any Region. If the Region already includes a replica of the key you're trying to replicate, ReplicateKey returns an AlreadyExistsException error. If the key state of the existing replica is PendingDeletion, you can cancel the scheduled key deletion (CancelKeyDeletion) or wait for the key to be deleted. The new replica key you create will have the same shared properties as the original replica key. The CloudTrail log of a ReplicateKey operation records a ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region. If you replicate a multi-Region primary key with imported key material, the replica key is created with no key material. You must import the same key material that you imported into the primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide. To convert a replica key to a primary key, use the UpdatePrimaryRegion operation. ReplicateKey uses different default values for the KeyPolicy and Tags parameters than those used in the KMS console. For details, see the parameter descriptions. Cross-account use: No. You cannot use this operation to create a replica key in a different Amazon Web Services account. Required permissions: kms:ReplicateKey on the primary key (in the primary key's Region). Include this permission in the primary key's key policy. kms:CreateKey in an IAM policy in the replica Region. To use the Tags parameter, kms:TagResource in an IAM policy in the replica Region. Related operations CreateKey UpdatePrimaryRegion */ replicateKey(input: AWS.KMS.ReplicateKeyRequest, options: SdkCallOptions): Promise; /** * Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To identify the grant to retire, use a grant token, or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation returns both values. This operation can be called by the retiring principal for a grant, by the grantee principal if the grant allows the RetireGrant operation, and by the Amazon Web Services account in which the grant is created. It can also be called by principals to whom permission for retiring a grant is delegated. For details, see Retiring and revoking grants in the Key Management Service Developer Guide. For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants. Cross-account use: Yes. You can retire a grant on a KMS key in a different Amazon Web Services account. Required permissions::Permission to retire a grant is determined primarily by the grant. For details, see Retiring and revoking grants in the Key Management Service Developer Guide. Related operations: CreateGrant ListGrants ListRetirableGrants RevokeGrant */ retireGrant(input: AWS.KMS.RetireGrantRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified grant. You revoke a grant to terminate the permissions that the grant allows. For more information, see Retiring and revoking grants in the Key Management Service Developer Guide . When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in the Key Management Service Developer Guide . For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:RevokeGrant (key policy). Related operations: CreateGrant ListGrants ListRetirableGrants RetireGrant */ revokeGrant(input: AWS.KMS.RevokeGrantRequest, options: SdkCallOptions): Promise<{}>; /** * Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it. Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting it, use DisableKey. If you schedule deletion of a KMS key from a custom key store, when the waiting period expires, ScheduleKeyDeletion deletes the KMS key from KMS. Then KMS makes a best effort to delete the key material from the associated CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. You can schedule the deletion of a multi-Region primary key and its replica keys at any time. However, KMS will not delete a multi-Region primary key with existing replica keys. If you schedule the deletion of a primary key with replicas, its key state changes to PendingReplicaDeletion and it cannot be replicated or used in cryptographic operations. This status can continue indefinitely. When the last of its replicas keys is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion and its waiting period (PendingWindowInDays) begins. For details, see Deleting multi-Region keys in the Key Management Service Developer Guide. For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:ScheduleKeyDeletion (key policy) Related operations CancelKeyDeletion DisableKey */ scheduleKeyDeletion(input: AWS.KMS.ScheduleKeyDeletionRequest, options: SdkCallOptions): Promise; /** * Creates a digital signature for a message or message digest by using the private key in an asymmetric signing KMS key. To verify the signature, use the Verify operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed. To use the Sign operation, provide the following information: Use the KeyId parameter to identify an asymmetric KMS key with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a KMS key, use the DescribeKey operation. The caller must have kms:Sign permission on the KMS key. Use the Message parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the Message parameter. To indicate whether the message is a full message or a digest, use the MessageType parameter. Choose a signing algorithm that is compatible with the KMS key. When signing a message, be sure to record the KMS key and the signing algorithm. This information is required to verify the signature. Best practices recommend that you limit the time during which any signature is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. Signatures do not include a timestamp, but you can include a timestamp in the signed message to help you detect when its time to refresh the signature. To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of KMS. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:Sign (key policy) Related operations: Verify */ sign(input: AWS.KMS.SignRequest, options: SdkCallOptions): Promise; /** * Adds or edits tags on a customer managed key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide. Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. 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 a customer managed key, but you cannot tag an Amazon Web Services managed key, an Amazon Web Services owned key, a custom key store, or an alias. You can also add tags to a KMS key while creating it (CreateKey) or replicating it (ReplicateKey). For information about using tags in KMS, see Tagging keys. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:TagResource (key policy) Related operations CreateKey ListResourceTags ReplicateKey UntagResource */ tagResource(input: AWS.KMS.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes tags from a customer managed key. To delete a tag, specify the tag key and the KMS key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide. When it succeeds, the UntagResource operation doesn't return any output. Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return a response. To confirm that the operation worked, use the ListResourceTags operation. For information about using tags in KMS, see Tagging keys. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:UntagResource (key policy) Related operations CreateKey ListResourceTags ReplicateKey TagResource */ untagResource(input: AWS.KMS.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Associates an existing KMS alias with a different KMS key. Each alias is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the KMS key must be in the same Amazon Web Services account and Region. Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide. The current and new KMS key must be the same type (both symmetric or both asymmetric), and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias. You cannot use UpdateAlias to change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias. Because an alias is not a property of a KMS key, you can create, update, and delete the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all KMS keys in the account, use the ListAliases operation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions kms:UpdateAlias on the alias (IAM policy). kms:UpdateAlias on the current KMS key (key policy). kms:UpdateAlias on the new KMS key (key policy). For details, see Controlling access to aliases in the Key Management Service Developer Guide. Related operations: CreateAlias DeleteAlias ListAliases */ updateAlias(input: AWS.KMS.UpdateAliasRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store. You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. The CustomKeyStoreId parameter is required in all commands. Use the other parameters of UpdateCustomKeyStore to edit your key store settings. Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify. Use the KeyStorePassword parameter tell KMS the current password of the kmsuser crypto user (CU) in the associated CloudHSM cluster. You can use this parameter to fix connection failures that occur when KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the CloudHSM cluster. Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, CloudHSM cluster. You can use this parameter to repair a custom key store if its CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the custom key store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store. Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. Required permissions: kms:UpdateCustomKeyStore (IAM policy) Related operations: ConnectCustomKeyStore CreateCustomKeyStore DeleteCustomKeyStore DescribeCustomKeyStores DisconnectCustomKeyStore */ updateCustomKeyStore(input: AWS.KMS.UpdateCustomKeyStoreRequest, options: SdkCallOptions): Promise; /** * Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:UpdateKeyDescription (key policy) Related operations CreateKey DescribeKey */ updateKeyDescription(input: AWS.KMS.UpdateKeyDescriptionRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the primary key of a multi-Region key. This operation changes the replica key in the specified Region to a primary key and changes the former primary key to a replica key. For example, suppose you have a primary key in us-east-1 and a replica key in eu-west-2. If you run UpdatePrimaryRegion with a PrimaryRegion value of eu-west-2, the primary key is now the key in eu-west-2, and the key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide. This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. The primary key of a multi-Region key is the source for properties that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material origin, and automatic key rotation. It's the only key that can be replicated. You cannot delete the primary key until all replica keys are deleted. The key ID and primary Region that you specify uniquely identify the replica key that will become the primary key. The primary Region must already have a replica key. This operation does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica key, use the ReplicateKey operation. You can run this operation while using the affected multi-Region keys in cryptographic operations. This operation should not delay, interrupt, or cause failures in cryptographic operations. Even after this operation completes, the process of updating the primary Region might still be in progress for a few more seconds. Operations such as DescribeKey might display both the old and new primary keys as replicas. The old and new primary keys have a transient key state of Updating. The original key state is restored when the update is complete. While the key state is Updating, you can use the keys in cryptographic operations, but you cannot replicate the new primary key or perform certain management operations, such as enabling or disabling these keys. For details about the Updating key state, see Key states of KMS keys in the Key Management Service Developer Guide. This operation does not return any output. To verify that primary key is changed, use the DescribeKey operation. Cross-account use: No. You cannot use this operation in a different Amazon Web Services account. Required permissions: kms:UpdatePrimaryRegion on the current primary key (in the primary key's Region). Include this permission primary key's key policy. kms:UpdatePrimaryRegion on the current replica key (in the replica key's Region). Include this permission in the replica key's key policy. Related operations CreateKey ReplicateKey */ updatePrimaryRegion(input: AWS.KMS.UpdatePrimaryRegionRequest, options: SdkCallOptions): Promise<{}>; /** * Verifies a digital signature that was generated by the Sign operation. Verification confirms that an authorized user signed the message with the specified KMS key and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception. A digital signature is generated by using the private key in an asymmetric KMS key. The signature is verified by using the public key in the same asymmetric KMS key. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. To verify a digital signature, you can use the Verify operation. Specify the same asymmetric KMS key, message, and signing algorithm that were used to produce the signature. You can also verify the digital signature by using the public key of the KMS key outside of KMS. Use the GetPublicKey operation to download the public key in the asymmetric KMS key and then use the public key to verify the signature outside of KMS. To verify a signature outside of KMS with an SM2 public key, you must specify the distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing ID. For more information, see Offline verification with SM2 key pairs in Key Management Service Developer Guide. The advantage of using the Verify operation is that it is performed within KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the KMS key to verify signatures. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:Verify (key policy) Related operations: Sign */ verify(input: AWS.KMS.VerifyRequest, options: SdkCallOptions): Promise; /** * Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC to the HMAC that you specify. If the HMACs are identical, the verification succeeds; otherwise, it fails. Verification indicates that the message hasn't changed since the HMAC was calculated, and the specified key was used to generate and verify the HMAC. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:VerifyMac (key policy) Related operations: GenerateMac */ verifyMac(input: AWS.KMS.VerifyMacRequest, options: SdkCallOptions): Promise; } export interface LakeFormation { /** * Attaches one or more LF-tags to an existing resource. */ addLFTagsToResource(input: AWS.LakeFormation.AddLFTagsToResourceRequest, options: SdkCallOptions): Promise; /** * Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session. This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API GetDataAccess. Therefore, all SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in their role policies. A typical IAM policy attached to such a role would look as follows: */ assumeDecoratedRoleWithSAML(input: AWS.LakeFormation.AssumeDecoratedRoleWithSAMLRequest, options: SdkCallOptions): Promise; /** * Batch operation to grant permissions to the principal. */ batchGrantPermissions(input: AWS.LakeFormation.BatchGrantPermissionsRequest, options: SdkCallOptions): Promise; /** * Batch operation to revoke permissions from the principal. */ batchRevokePermissions(input: AWS.LakeFormation.BatchRevokePermissionsRequest, options: SdkCallOptions): Promise; /** * Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed. */ cancelTransaction(input: AWS.LakeFormation.CancelTransactionRequest, options: SdkCallOptions): Promise; /** * Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction. */ commitTransaction(input: AWS.LakeFormation.CommitTransactionRequest, options: SdkCallOptions): Promise; /** * Creates a data cell filter to allow one to grant access to certain columns on certain rows. */ createDataCellsFilter(input: AWS.LakeFormation.CreateDataCellsFilterRequest, options: SdkCallOptions): Promise; /** * Creates an LF-tag with the specified name and values. */ createLFTag(input: AWS.LakeFormation.CreateLFTagRequest, options: SdkCallOptions): Promise; /** * Deletes a data cell filter. */ deleteDataCellsFilter(input: AWS.LakeFormation.DeleteDataCellsFilterRequest, options: SdkCallOptions): Promise; /** * Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource. */ deleteLFTag(input: AWS.LakeFormation.DeleteLFTagRequest, options: SdkCallOptions): Promise; /** * For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels. The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes. */ deleteObjectsOnCancel(input: AWS.LakeFormation.DeleteObjectsOnCancelRequest, options: SdkCallOptions): Promise; /** * Deregisters the resource as managed by the Data Catalog. When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role. */ deregisterResource(input: AWS.LakeFormation.DeregisterResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves the current data access role for the given resource registered in Lake Formation. */ describeResource(input: AWS.LakeFormation.DescribeResourceRequest, options: SdkCallOptions): Promise; /** * Returns the details of a single transaction. */ describeTransaction(input: AWS.LakeFormation.DescribeTransactionRequest, options: SdkCallOptions): Promise; /** * Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted. Write transactions that remain idle for a long period are automatically aborted unless explicitly extended. */ extendTransaction(input: AWS.LakeFormation.ExtendTransactionRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of the data lake administrators of a Lake Formation-managed data lake. */ getDataLakeSettings(input: AWS.LakeFormation.GetDataLakeSettingsRequest, options: SdkCallOptions): Promise; /** * Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted. */ getEffectivePermissionsForPath(input: AWS.LakeFormation.GetEffectivePermissionsForPathRequest, options: SdkCallOptions): Promise; /** * Returns an LF-tag definition. */ getLFTag(input: AWS.LakeFormation.GetLFTagRequest, options: SdkCallOptions): Promise; /** * Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning. */ getQueryState(input: AWS.LakeFormation.GetQueryStateRequest, options: SdkCallOptions): Promise; /** * Retrieves statistics on the planning and execution of a query. */ getQueryStatistics(input: AWS.LakeFormation.GetQueryStatisticsRequest, options: SdkCallOptions): Promise; /** * Returns the LF-tags applied to a resource. */ getResourceLFTags(input: AWS.LakeFormation.GetResourceLFTagsRequest, options: SdkCallOptions): Promise; /** * Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries. */ getTableObjects(input: AWS.LakeFormation.GetTableObjectsRequest, options: SdkCallOptions): Promise; /** * This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix. */ getTemporaryGluePartitionCredentials(input: AWS.LakeFormation.GetTemporaryGluePartitionCredentialsRequest, options: SdkCallOptions): Promise; /** * Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix. */ getTemporaryGlueTableCredentials(input: AWS.LakeFormation.GetTemporaryGlueTableCredentialsRequest, options: SdkCallOptions): Promise; /** * Returns the work units resulting from the query. Work units can be executed in any order and in parallel. */ getWorkUnitResults(input: AWS.LakeFormation.GetWorkUnitResultsRequest, options: SdkCallOptions): Promise; /** * Retrieves the work units generated by the StartQueryPlanning operation. */ getWorkUnits(input: AWS.LakeFormation.GetWorkUnitsRequest, options: SdkCallOptions): Promise; /** * Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. For information about permissions, see Security and Access Control to Metadata and Data. */ grantPermissions(input: AWS.LakeFormation.GrantPermissionsRequest, options: SdkCallOptions): Promise; /** * Lists all the data cell filters on a table. */ listDataCellsFilter(input: AWS.LakeFormation.ListDataCellsFilterRequest, options: SdkCallOptions): Promise; /** * Lists LF-tags that the requester has permission to view. */ listLFTags(input: AWS.LakeFormation.ListLFTagsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER. This operation returns only those permissions that have been explicitly granted. For information about permissions, see Security and Access Control to Metadata and Data. */ listPermissions(input: AWS.LakeFormation.ListPermissionsRequest, options: SdkCallOptions): Promise; /** * Lists the resources registered to be managed by the Data Catalog. */ listResources(input: AWS.LakeFormation.ListResourcesRequest, options: SdkCallOptions): Promise; /** * Returns the configuration of all storage optimizers associated with a specified table. */ listTableStorageOptimizers(input: AWS.LakeFormation.ListTableStorageOptimizersRequest, options: SdkCallOptions): Promise; /** * Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned. This operation can help you identify uncommitted transactions or to get information about transactions. */ listTransactions(input: AWS.LakeFormation.ListTransactionsRequest, options: SdkCallOptions): Promise; /** * Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions. This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API. */ putDataLakeSettings(input: AWS.LakeFormation.PutDataLakeSettingsRequest, options: SdkCallOptions): Promise; /** * Registers the resource as managed by the Data Catalog. To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy. The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location. ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn: arn:aws:iam::12345:role/my-data-access-role */ registerResource(input: AWS.LakeFormation.RegisterResourceRequest, options: SdkCallOptions): Promise; /** * Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input. */ removeLFTagsFromResource(input: AWS.LakeFormation.RemoveLFTagsFromResourceRequest, options: SdkCallOptions): Promise; /** * Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. */ revokePermissions(input: AWS.LakeFormation.RevokePermissionsRequest, options: SdkCallOptions): Promise; /** * This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared. */ searchDatabasesByLFTags(input: AWS.LakeFormation.SearchDatabasesByLFTagsRequest, options: SdkCallOptions): Promise; /** * This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared. */ searchTablesByLFTags(input: AWS.LakeFormation.SearchTablesByLFTagsRequest, options: SdkCallOptions): Promise; /** * Submits a request to process a query statement. This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED. */ startQueryPlanning(input: AWS.LakeFormation.StartQueryPlanningRequest, options: SdkCallOptions): Promise; /** * Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction. */ startTransaction(input: AWS.LakeFormation.StartTransactionRequest, options: SdkCallOptions): Promise; /** * Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value. */ updateLFTag(input: AWS.LakeFormation.UpdateLFTagRequest, options: SdkCallOptions): Promise; /** * Updates the data access role used for vending access to the given (registered) resource in Lake Formation. */ updateResource(input: AWS.LakeFormation.UpdateResourceRequest, options: SdkCallOptions): Promise; /** * Updates the manifest of Amazon S3 objects that make up the specified governed table. */ updateTableObjects(input: AWS.LakeFormation.UpdateTableObjectsRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of the storage optimizers for a table. */ updateTableStorageOptimizer(input: AWS.LakeFormation.UpdateTableStorageOptimizerRequest, options: SdkCallOptions): Promise; } export interface Lambda { /** * Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts. To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it. */ addLayerVersionPermission(input: AWS.Lambda.AddLayerVersionPermissionRequest, options: SdkCallOptions): Promise; /** * Grants an Amazon Web Services service, account, or organization permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST. To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies. */ addPermission(input: AWS.Lambda.AddPermissionRequest, options: SdkCallOptions): Promise; /** * Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives. */ createAlias(input: AWS.Lambda.CreateAliasRequest, options: SdkCallOptions): Promise; /** * Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail). */ createCodeSigningConfig(input: AWS.Lambda.CreateCodeSigningConfigRequest, options: SdkCallOptions): Promise; /** * Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function. For details about how to configure different event sources, see the following topics. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka The following error handling options are available only for stream sources (DynamoDB and Kinesis): BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry. DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic. MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires MaximumRetryAttempts - Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires. ParallelizationFactor - Process multiple batches from each shard concurrently. For information about which configuration parameters apply to each event source, see the following topics. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka */ createEventSourceMapping(input: AWS.Lambda.CreateEventSourceMappingRequest, options: SdkCallOptions): Promise; /** * Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing. You set the package type to Image if the deployment package is a container image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. You set the package type to Zip if the deployment package is a .zip file archive. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, the default value is x86-64. When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States. A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration. The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency). You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set set of signing profiles, which define the trusted publishers for this function. If another account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias. To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions. */ createFunction(input: AWS.Lambda.CreateFunctionRequest, options: SdkCallOptions): Promise; /** * Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function. */ createFunctionUrlConfig(input: AWS.Lambda.CreateFunctionUrlConfigRequest, options: SdkCallOptions): Promise; /** * Deletes a Lambda function alias. */ deleteAlias(input: AWS.Lambda.DeleteAliasRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it. */ deleteCodeSigningConfig(input: AWS.Lambda.DeleteCodeSigningConfigRequest, options: SdkCallOptions): Promise; /** * Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds. */ deleteEventSourceMapping(input: AWS.Lambda.DeleteEventSourceMappingRequest, options: SdkCallOptions): Promise; /** * Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it. */ deleteFunction(input: AWS.Lambda.DeleteFunctionRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the code signing configuration from the function. */ deleteFunctionCodeSigningConfig(input: AWS.Lambda.DeleteFunctionCodeSigningConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Removes a concurrent execution limit from a function. */ deleteFunctionConcurrency(input: AWS.Lambda.DeleteFunctionConcurrencyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. */ deleteFunctionEventInvokeConfig(input: AWS.Lambda.DeleteFunctionEventInvokeConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address. */ deleteFunctionUrlConfig(input: AWS.Lambda.DeleteFunctionUrlConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it. */ deleteLayerVersion(input: AWS.Lambda.DeleteLayerVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the provisioned concurrency configuration for a function. */ deleteProvisionedConcurrencyConfig(input: AWS.Lambda.DeleteProvisionedConcurrencyConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves details about your account's limits and usage in an Amazon Web Services Region. */ getAccountSettings(input: AWS.Lambda.GetAccountSettingsRequest, options: SdkCallOptions): Promise; /** * Returns details about a Lambda function alias. */ getAlias(input: AWS.Lambda.GetAliasRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified code signing configuration. */ getCodeSigningConfig(input: AWS.Lambda.GetCodeSigningConfigRequest, options: SdkCallOptions): Promise; /** * Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. */ getEventSourceMapping(input: AWS.Lambda.GetEventSourceMappingRequest, options: SdkCallOptions): Promise; /** * Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned. */ getFunction(input: AWS.Lambda.GetFunctionRequest, options: SdkCallOptions): Promise; /** * Returns the code signing configuration for the specified function. */ getFunctionCodeSigningConfig(input: AWS.Lambda.GetFunctionCodeSigningConfigRequest, options: SdkCallOptions): Promise; /** * Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency. */ getFunctionConcurrency(input: AWS.Lambda.GetFunctionConcurrencyRequest, options: SdkCallOptions): Promise; /** * Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration. To get all of a function's details, including function-level settings, use GetFunction. */ getFunctionConfiguration(input: AWS.Lambda.GetFunctionConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. */ getFunctionEventInvokeConfig(input: AWS.Lambda.GetFunctionEventInvokeConfigRequest, options: SdkCallOptions): Promise; /** * Returns details about a Lambda function URL. */ getFunctionUrlConfig(input: AWS.Lambda.GetFunctionUrlConfigRequest, options: SdkCallOptions): Promise; /** * Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes. */ getLayerVersion(input: AWS.Lambda.GetLayerVersionRequest, options: SdkCallOptions): Promise; /** * Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes. */ getLayerVersionByArn(input: AWS.Lambda.GetLayerVersionByArnRequest, options: SdkCallOptions): Promise; /** * Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission. */ getLayerVersionPolicy(input: AWS.Lambda.GetLayerVersionPolicyRequest, options: SdkCallOptions): Promise; /** * Returns the resource-based IAM policy for a function, version, or alias. */ getPolicy(input: AWS.Lambda.GetPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves the provisioned concurrency configuration for a function's alias or version. */ getProvisionedConcurrencyConfig(input: AWS.Lambda.GetProvisionedConcurrencyConfigRequest, options: SdkCallOptions): Promise; /** * Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event. For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior. For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue. The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded). For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings. This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts. */ invoke(input: AWS.Lambda.InvocationRequest, options: SdkCallOptions): Promise; /** * For asynchronous function invocation, use Invoke. Invokes a function asynchronously. */ invokeAsync(input: AWS.Lambda.InvokeAsyncRequest, options: SdkCallOptions): Promise; /** * Returns a list of aliases for a Lambda function. */ listAliases(input: AWS.Lambda.ListAliasesRequest, options: SdkCallOptions): Promise; /** * Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call. */ listCodeSigningConfigs(input: AWS.Lambda.ListCodeSigningConfigsRequest, options: SdkCallOptions): Promise; /** * Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source. */ listEventSourceMappings(input: AWS.Lambda.ListEventSourceMappingsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. */ listFunctionEventInvokeConfigs(input: AWS.Lambda.ListFunctionEventInvokeConfigsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Lambda function URLs for the specified function. */ listFunctionUrlConfigs(input: AWS.Lambda.ListFunctionUrlConfigsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call. Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version. The ListFunctions action returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) for a function or version, use GetFunction. */ listFunctions(input: AWS.Lambda.ListFunctionsRequest, options: SdkCallOptions): Promise; /** * List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it. */ listFunctionsByCodeSigningConfig(input: AWS.Lambda.ListFunctionsByCodeSigningConfigRequest, options: SdkCallOptions): Promise; /** * Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture. */ listLayerVersions(input: AWS.Lambda.ListLayerVersionsRequest, options: SdkCallOptions): Promise; /** * Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture. */ listLayers(input: AWS.Lambda.ListLayersRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of provisioned concurrency configurations for a function. */ listProvisionedConcurrencyConfigs(input: AWS.Lambda.ListProvisionedConcurrencyConfigsRequest, options: SdkCallOptions): Promise; /** * Returns a function's tags. You can also view tags with GetFunction. */ listTags(input: AWS.Lambda.ListTagsRequest, options: SdkCallOptions): Promise; /** * Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call. */ listVersionsByFunction(input: AWS.Lambda.ListVersionsByFunctionRequest, options: SdkCallOptions): Promise; /** * Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created. Add layers to your function with CreateFunction or UpdateFunctionConfiguration. */ publishLayerVersion(input: AWS.Lambda.PublishLayerVersionRequest, options: SdkCallOptions): Promise; /** * Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change. Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version. Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias. */ publishVersion(input: AWS.Lambda.PublishVersionRequest, options: SdkCallOptions): Promise; /** * Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function. */ putFunctionCodeSigningConfig(input: AWS.Lambda.PutFunctionCodeSigningConfigRequest, options: SdkCallOptions): Promise; /** * Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level. Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function. Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency. */ putFunctionConcurrency(input: AWS.Lambda.PutFunctionConcurrencyRequest, options: SdkCallOptions): Promise; /** * Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig. By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration. To send an invocation record to a queue, topic, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue. */ putFunctionEventInvokeConfig(input: AWS.Lambda.PutFunctionEventInvokeConfigRequest, options: SdkCallOptions): Promise; /** * Adds a provisioned concurrency configuration to a function's alias or version. */ putProvisionedConcurrencyConfig(input: AWS.Lambda.PutProvisionedConcurrencyConfigRequest, options: SdkCallOptions): Promise; /** * Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission. */ removeLayerVersionPermission(input: AWS.Lambda.RemoveLayerVersionPermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Revokes function-use permission from an Amazon Web Services service or another account. You can get the ID of the statement from the output of GetPolicy. */ removePermission(input: AWS.Lambda.RemovePermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Adds tags to a function. */ tagResource(input: AWS.Lambda.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes tags from a function. */ untagResource(input: AWS.Lambda.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the configuration of a Lambda function alias. */ updateAlias(input: AWS.Lambda.UpdateAliasRequest, options: SdkCallOptions): Promise; /** * Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function. */ updateCodeSigningConfig(input: AWS.Lambda.UpdateCodeSigningConfigRequest, options: SdkCallOptions): Promise; /** * Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location. For details about how to configure different event sources, see the following topics. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka The following error handling options are available only for stream sources (DynamoDB and Kinesis): BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry. DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic. MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires MaximumRetryAttempts - Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires. ParallelizationFactor - Process multiple batches from each shard concurrently. For information about which configuration parameters apply to each event source, see the following topics. Amazon DynamoDB Streams Amazon Kinesis Amazon SQS Amazon MQ and RabbitMQ Amazon MSK Apache Kafka */ updateEventSourceMapping(input: AWS.Lambda.UpdateEventSourceMappingRequest, options: SdkCallOptions): Promise; /** * Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing. If the function's package type is Image, you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry. If the function's package type is Zip, you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version. For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function. */ updateFunctionCode(input: AWS.Lambda.UpdateFunctionCodeRequest, options: SdkCallOptions): Promise; /** * Modify the version-specific settings of a Lambda function. When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States. These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version. To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or Amazon Web Services service, use AddPermission. */ updateFunctionConfiguration(input: AWS.Lambda.UpdateFunctionConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. */ updateFunctionEventInvokeConfig(input: AWS.Lambda.UpdateFunctionEventInvokeConfigRequest, options: SdkCallOptions): Promise; /** * Updates the configuration for a Lambda function URL. */ updateFunctionUrlConfig(input: AWS.Lambda.UpdateFunctionUrlConfigRequest, options: SdkCallOptions): Promise; } export interface LexModelBuildingService { /** * Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version. You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation. When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permission for the lex:CreateBotVersion action. */ createBotVersion(input: AWS.LexModelBuildingService.CreateBotVersionRequest, options: SdkCallOptions): Promise; /** * Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created. You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation. When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions to perform the lex:CreateIntentVersion action. */ createIntentVersion(input: AWS.LexModelBuildingService.CreateIntentVersionRequest, options: SdkCallOptions): Promise; /** * Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created. You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation. When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions for the lex:CreateSlotTypeVersion action. */ createSlotTypeVersion(input: AWS.LexModelBuildingService.CreateSlotTypeVersionRequest, options: SdkCallOptions): Promise; /** * Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later. Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful. This operation requires permissions for the lex:DeleteBot action. */ deleteBot(input: AWS.LexModelBuildingService.DeleteBotRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an alias for the specified bot. You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful. */ deleteBotAlias(input: AWS.LexModelBuildingService.DeleteBotAliasRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action. */ deleteBotChannelAssociation(input: AWS.LexModelBuildingService.DeleteBotChannelAssociationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the lex:DeleteBotVersion action. */ deleteBotVersion(input: AWS.LexModelBuildingService.DeleteBotVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation. You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first. If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful. This operation requires permission for the lex:DeleteIntent action. */ deleteIntent(input: AWS.LexModelBuildingService.DeleteIntentRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions for the lex:DeleteIntentVersion action. */ deleteIntentVersion(input: AWS.LexModelBuildingService.DeleteIntentVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation. You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful. This operation requires permission for the lex:DeleteSlotType action. */ deleteSlotType(input: AWS.LexModelBuildingService.DeleteSlotTypeRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires permissions for the lex:DeleteSlotTypeVersion action. */ deleteSlotTypeVersion(input: AWS.LexModelBuildingService.DeleteSlotTypeVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the DeleteUtterances operation to manually delete stored utterances for a specific user. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the GetUtterancesView operation are deleted after 15 days. This operation requires permissions for the lex:DeleteUtterances action. */ deleteUtterances(input: AWS.LexModelBuildingService.DeleteUtterancesRequest, options: SdkCallOptions): Promise<{}>; /** * Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions for the lex:GetBot action. */ getBot(input: AWS.LexModelBuildingService.GetBotRequest, options: SdkCallOptions): Promise; /** * Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:GetBotAlias action. */ getBotAlias(input: AWS.LexModelBuildingService.GetBotAliasRequest, options: SdkCallOptions): Promise; /** * Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action. */ getBotAliases(input: AWS.LexModelBuildingService.GetBotAliasesRequest, options: SdkCallOptions): Promise; /** * Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action. */ getBotChannelAssociation(input: AWS.LexModelBuildingService.GetBotChannelAssociationRequest, options: SdkCallOptions): Promise; /** * Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action. */ getBotChannelAssociations(input: AWS.LexModelBuildingService.GetBotChannelAssociationsRequest, options: SdkCallOptions): Promise; /** * Gets information about all of the versions of a bot. The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetBotVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetBotVersions action. */ getBotVersions(input: AWS.LexModelBuildingService.GetBotVersionsRequest, options: SdkCallOptions): Promise; /** * Returns bot information as follows: If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string. If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots. This operation requires permission for the lex:GetBots action. */ getBots(input: AWS.LexModelBuildingService.GetBotsRequest, options: SdkCallOptions): Promise; /** * Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action. */ getBuiltinIntent(input: AWS.LexModelBuildingService.GetBuiltinIntentRequest, options: SdkCallOptions): Promise; /** * Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action. */ getBuiltinIntents(input: AWS.LexModelBuildingService.GetBuiltinIntentsRequest, options: SdkCallOptions): Promise; /** * Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the lex:GetBuiltInSlotTypes action. */ getBuiltinSlotTypes(input: AWS.LexModelBuildingService.GetBuiltinSlotTypesRequest, options: SdkCallOptions): Promise; /** * Exports the contents of a Amazon Lex resource in a specified format. */ getExport(input: AWS.LexModelBuildingService.GetExportRequest, options: SdkCallOptions): Promise; /** * Gets information about an import job started with the StartImport operation. */ getImport(input: AWS.LexModelBuildingService.GetImportRequest, options: SdkCallOptions): Promise; /** * Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to perform the lex:GetIntent action. */ getIntent(input: AWS.LexModelBuildingService.GetIntentRequest, options: SdkCallOptions): Promise; /** * Gets information about all of the versions of an intent. The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetIntentVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetIntentVersions action. */ getIntentVersions(input: AWS.LexModelBuildingService.GetIntentVersionsRequest, options: SdkCallOptions): Promise; /** * Returns intent information as follows: If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all intents. The operation requires permission for the lex:GetIntents action. */ getIntents(input: AWS.LexModelBuildingService.GetIntentsRequest, options: SdkCallOptions): Promise; /** * Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration. */ getMigration(input: AWS.LexModelBuildingService.GetMigrationRequest, options: SdkCallOptions): Promise; /** * Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2. */ getMigrations(input: AWS.LexModelBuildingService.GetMigrationsRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version. This operation requires permissions for the lex:GetSlotType action. */ getSlotType(input: AWS.LexModelBuildingService.GetSlotTypeRequest, options: SdkCallOptions): Promise; /** * Gets information about all versions of a slot type. The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetSlotTypeVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetSlotTypeVersions action. */ getSlotTypeVersions(input: AWS.LexModelBuildingService.GetSlotTypeVersionsRequest, options: SdkCallOptions): Promise; /** * Returns slot type information as follows: If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all slot types. The operation requires permission for the lex:GetSlotTypes action. */ getSlotTypes(input: AWS.LexModelBuildingService.GetSlotTypesRequest, options: SdkCallOptions): Promise; /** * Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to. For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance. After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version. If you set childDirected field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available. This operation requires permissions for the lex:GetUtterancesView action. */ getUtterancesView(input: AWS.LexModelBuildingService.GetUtterancesViewRequest, options: SdkCallOptions): Promise; /** * Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them. */ listTagsForResource(input: AWS.LexModelBuildingService.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see security-iam. */ putBot(input: AWS.LexModelBuildingService.PutBotRequest, options: SdkCallOptions): Promise; /** * Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:PutBotAlias action. */ putBotAlias(input: AWS.LexModelBuildingService.PutBotAliasRequest, options: SdkCallOptions): Promise; /** * Creates an intent or replaces an existing intent. To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent. To create an intent or replace an existing intent, you must provide the following: Intent name. For example, OrderPizza. Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza." Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza. How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. You can specify other optional information in the request, such as: A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order." A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?" If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT. For more information, see how-it-works. This operation requires permissions for the lex:PutIntent action. */ putIntent(input: AWS.LexModelBuildingService.PutIntentRequest, options: SdkCallOptions): Promise; /** * Creates a custom slot type or replaces an existing custom slot type. To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works. If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT. This operation requires permissions for the lex:PutSlotType action. */ putSlotType(input: AWS.LexModelBuildingService.PutSlotTypeRequest, options: SdkCallOptions): Promise; /** * Starts a job to import a resource to Amazon Lex. */ startImport(input: AWS.LexModelBuildingService.StartImportRequest, options: SdkCallOptions): Promise; /** * Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2. For more information, see Migrating a bot in the Amazon Lex developer guide. */ startMigration(input: AWS.LexModelBuildingService.StartMigrationRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value. */ tagResource(input: AWS.LexModelBuildingService.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a bot, bot alias or bot channel. */ untagResource(input: AWS.LexModelBuildingService.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface LexModelsV2 { /** * Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot. */ buildBotLocale(input: AWS.LexModelsV2.BuildBotLocaleRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Lex conversational bot. */ createBot(input: AWS.LexModelsV2.CreateBotRequest, options: SdkCallOptions): Promise; /** * Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot. For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot. */ createBotAlias(input: AWS.LexModelsV2.CreateBotAliasRequest, options: SdkCallOptions): Promise; /** * Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot. */ createBotLocale(input: AWS.LexModelsV2.CreateBotLocaleRequest, options: SdkCallOptions): Promise; /** * Creates a new version of the bot based on the DRAFT version. If the DRAFT version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it returns the last created version. When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. */ createBotVersion(input: AWS.LexModelsV2.CreateBotVersionRequest, options: SdkCallOptions): Promise; /** * Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot. You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale. For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots */ createExport(input: AWS.LexModelsV2.CreateExportRequest, options: SdkCallOptions): Promise; /** * Creates an intent. To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent. When you create an intent, you must provide a name. You can optionally provide the following: Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents. Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application. How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available. A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza." A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?" */ createIntent(input: AWS.LexModelsV2.CreateIntentRequest, options: SdkCallOptions): Promise; /** * Creates a new resource policy with the specified policy statements. */ createResourcePolicy(input: AWS.LexModelsV2.CreateResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created. You can't create a resource policy statement that allows cross-account access. */ createResourcePolicyStatement(input: AWS.LexModelsV2.CreateResourcePolicyStatementRequest, options: SdkCallOptions): Promise; /** * Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user. */ createSlot(input: AWS.LexModelsV2.CreateSlotRequest, options: SdkCallOptions): Promise; /** * Creates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume. */ createSlotType(input: AWS.LexModelsV2.CreateSlotTypeRequest, options: SdkCallOptions): Promise; /** * Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale. */ createUploadUrl(input: AWS.LexModelsV2.CreateUploadUrlRequest, options: SdkCallOptions): Promise; /** * Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation. When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot. If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true. */ deleteBot(input: AWS.LexModelsV2.DeleteBotRequest, options: SdkCallOptions): Promise; /** * Deletes the specified bot alias. */ deleteBotAlias(input: AWS.LexModelsV2.DeleteBotAliasRequest, options: SdkCallOptions): Promise; /** * Removes a locale from a bot. When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted. */ deleteBotLocale(input: AWS.LexModelsV2.DeleteBotLocaleRequest, options: SdkCallOptions): Promise; /** * Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation. */ deleteBotVersion(input: AWS.LexModelsV2.DeleteBotVersionRequest, options: SdkCallOptions): Promise; /** * Removes a custom vocabulary from the specified locale in the specified bot. */ deleteCustomVocabulary(input: AWS.LexModelsV2.DeleteCustomVocabularyRequest, options: SdkCallOptions): Promise; /** * Removes a previous export and the associated files stored in an S3 bucket. */ deleteExport(input: AWS.LexModelsV2.DeleteExportRequest, options: SdkCallOptions): Promise; /** * Removes a previous import and the associated file stored in an S3 bucket. */ deleteImport(input: AWS.LexModelsV2.DeleteImportRequest, options: SdkCallOptions): Promise; /** * Removes the specified intent. Deleting an intent also deletes the slots associated with the intent. */ deleteIntent(input: AWS.LexModelsV2.DeleteIntentRequest, options: SdkCallOptions): Promise<{}>; /** * Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception. */ deleteResourcePolicy(input: AWS.LexModelsV2.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception. */ deleteResourcePolicyStatement(input: AWS.LexModelsV2.DeleteResourcePolicyStatementRequest, options: SdkCallOptions): Promise; /** * Deletes the specified slot from an intent. */ deleteSlot(input: AWS.LexModelsV2.DeleteSlotRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a slot type from a bot locale. If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true. */ deleteSlotType(input: AWS.LexModelsV2.DeleteSlotTypeRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.. Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days. */ deleteUtterances(input: AWS.LexModelsV2.DeleteUtterancesRequest, options: SdkCallOptions): Promise; /** * Provides metadata information about a bot. */ describeBot(input: AWS.LexModelsV2.DescribeBotRequest, options: SdkCallOptions): Promise; /** * Get information about a specific bot alias. */ describeBotAlias(input: AWS.LexModelsV2.DescribeBotAliasRequest, options: SdkCallOptions): Promise; /** * Describes the settings that a bot has for a specific locale. */ describeBotLocale(input: AWS.LexModelsV2.DescribeBotLocaleRequest, options: SdkCallOptions): Promise; /** * Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation. */ describeBotRecommendation(input: AWS.LexModelsV2.DescribeBotRecommendationRequest, options: SdkCallOptions): Promise; /** * Provides metadata about a version of a bot. */ describeBotVersion(input: AWS.LexModelsV2.DescribeBotVersionRequest, options: SdkCallOptions): Promise; /** * Provides metadata information about a custom vocabulary. */ describeCustomVocabularyMetadata(input: AWS.LexModelsV2.DescribeCustomVocabularyMetadataRequest, options: SdkCallOptions): Promise; /** * Gets information about a specific export. */ describeExport(input: AWS.LexModelsV2.DescribeExportRequest, options: SdkCallOptions): Promise; /** * Gets information about a specific import. */ describeImport(input: AWS.LexModelsV2.DescribeImportRequest, options: SdkCallOptions): Promise; /** * Returns metadata about an intent. */ describeIntent(input: AWS.LexModelsV2.DescribeIntentRequest, options: SdkCallOptions): Promise; /** * Gets the resource policy and policy revision for a bot or bot alias. */ describeResourcePolicy(input: AWS.LexModelsV2.DescribeResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Gets metadata information about a slot. */ describeSlot(input: AWS.LexModelsV2.DescribeSlotRequest, options: SdkCallOptions): Promise; /** * Gets metadata information about a slot type. */ describeSlotType(input: AWS.LexModelsV2.DescribeSlotTypeRequest, options: SdkCallOptions): Promise; /** * Provides a list of utterances that users have sent to the bot. Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response. You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent. Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time. Utterances statistics are not generated under the following conditions: The childDirected field was set to true when the bot was created. You are using slot obfuscation with one or more slots. You opted out of participating in improving Amazon Lex. */ listAggregatedUtterances(input: AWS.LexModelsV2.ListAggregatedUtterancesRequest, options: SdkCallOptions): Promise; /** * Gets a list of aliases for the specified bot. */ listBotAliases(input: AWS.LexModelsV2.ListBotAliasesRequest, options: SdkCallOptions): Promise; /** * Gets a list of locales for the specified bot. */ listBotLocales(input: AWS.LexModelsV2.ListBotLocalesRequest, options: SdkCallOptions): Promise; /** * Get a list of bot recommendations that meet the specified criteria. */ listBotRecommendations(input: AWS.LexModelsV2.ListBotRecommendationsRequest, options: SdkCallOptions): Promise; /** * Gets information about all of the versions of a bot. The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version. The ListBotVersions operation always returns at least one version, the DRAFT version. */ listBotVersions(input: AWS.LexModelsV2.ListBotVersionsRequest, options: SdkCallOptions): Promise; /** * Gets a list of available bots. */ listBots(input: AWS.LexModelsV2.ListBotsRequest, options: SdkCallOptions): Promise; /** * Gets a list of built-in intents provided by Amazon Lex that you can use in your bot. To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent. */ listBuiltInIntents(input: AWS.LexModelsV2.ListBuiltInIntentsRequest, options: SdkCallOptions): Promise; /** * Gets a list of built-in slot types that meet the specified criteria. */ listBuiltInSlotTypes(input: AWS.LexModelsV2.ListBuiltInSlotTypesRequest, options: SdkCallOptions): Promise; /** * Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days. */ listExports(input: AWS.LexModelsV2.ListExportsRequest, options: SdkCallOptions): Promise; /** * Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days. */ listImports(input: AWS.LexModelsV2.ListImportsRequest, options: SdkCallOptions): Promise; /** * Get a list of intents that meet the specified criteria. */ listIntents(input: AWS.LexModelsV2.ListIntentsRequest, options: SdkCallOptions): Promise; /** * Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. */ listRecommendedIntents(input: AWS.LexModelsV2.ListRecommendedIntentsRequest, options: SdkCallOptions): Promise; /** * Gets a list of slot types that match the specified criteria. */ listSlotTypes(input: AWS.LexModelsV2.ListSlotTypesRequest, options: SdkCallOptions): Promise; /** * Gets a list of slots that match the specified criteria. */ listSlots(input: AWS.LexModelsV2.ListSlotsRequest, options: SdkCallOptions): Promise; /** * Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them. */ listTagsForResource(input: AWS.LexModelsV2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Search for associated transcripts that meet the specified criteria. */ searchAssociatedTranscripts(input: AWS.LexModelsV2.SearchAssociatedTranscriptsRequest, options: SdkCallOptions): Promise; /** * Use this to provide your transcript data, and to start the bot recommendation process. */ startBotRecommendation(input: AWS.LexModelsV2.StartBotRecommendationRequest, options: SdkCallOptions): Promise; /** * Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket. */ startImport(input: AWS.LexModelsV2.StartImportRequest, options: SdkCallOptions): Promise; /** * Stop an already running Bot Recommendation request. */ stopBotRecommendation(input: AWS.LexModelsV2.StopBotRecommendationRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value. */ tagResource(input: AWS.LexModelsV2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a bot, bot alias, or bot channel. */ untagResource(input: AWS.LexModelsV2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an existing bot. */ updateBot(input: AWS.LexModelsV2.UpdateBotRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an existing bot alias. */ updateBotAlias(input: AWS.LexModelsV2.UpdateBotAliasRequest, options: SdkCallOptions): Promise; /** * Updates the settings that a bot has for a specific locale. */ updateBotLocale(input: AWS.LexModelsV2.UpdateBotLocaleRequest, options: SdkCallOptions): Promise; /** * Updates an existing bot recommendation request. */ updateBotRecommendation(input: AWS.LexModelsV2.UpdateBotRecommendationRequest, options: SdkCallOptions): Promise; /** * Updates the password used to protect an export zip archive. The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation. */ updateExport(input: AWS.LexModelsV2.UpdateExportRequest, options: SdkCallOptions): Promise; /** * Updates the settings for an intent. */ updateIntent(input: AWS.LexModelsV2.UpdateIntentRequest, options: SdkCallOptions): Promise; /** * Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception. */ updateResourcePolicy(input: AWS.LexModelsV2.UpdateResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Updates the settings for a slot. */ updateSlot(input: AWS.LexModelsV2.UpdateSlotRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an existing slot type. */ updateSlotType(input: AWS.LexModelsV2.UpdateSlotTypeRequest, options: SdkCallOptions): Promise; } export interface LexRuntime { /** * Removes session information for a specified bot, alias, and user ID. */ deleteSession(input: AWS.LexRuntime.DeleteSessionRequest, options: SdkCallOptions): Promise; /** * Returns session information for a specified bot, alias, and user ID. */ getSession(input: AWS.LexRuntime.GetSessionRequest, options: SdkCallOptions): Promise; /** * Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot. The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications. In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages: For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?". After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?". After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.". Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples: If the message is to elicit slot data, Amazon Lex returns the following context information: x-amz-lex-dialog-state header set to ElicitSlot x-amz-lex-intent-name header set to the intent name in the current context x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting information x-amz-lex-slots header set to a map of slots configured for the intent with their current values If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted. If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the x-amz-dialog-state header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted. In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context. */ postContent(input: AWS.LexRuntime.PostContentRequest, options: SdkCallOptions): Promise; /** * Sends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot. In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages: For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?" After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?". After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.". Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a "yes" or "no" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples: If the message is to elicit slot data, Amazon Lex returns the following context information: dialogState set to ElicitSlot intentName set to the intent name in the current context slotToElicit set to the slot name for which the message is eliciting information slots set to a map of slots, configured for the intent, with currently known values If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null. If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null. In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context. */ postText(input: AWS.LexRuntime.PostTextRequest, options: SdkCallOptions): Promise; /** * Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot. For more information, see Managing Sessions. */ putSession(input: AWS.LexRuntime.PutSessionRequest, options: SdkCallOptions): Promise; } export interface LexRuntimeV2 { /** * Removes session information for a specified bot, alias, and user ID. You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again. You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours. If you specify a bot or alias ID that doesn't exist, you receive a BadRequestException. If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a BadRequestException. */ deleteSession(input: AWS.LexRuntimeV2.DeleteSessionRequest, options: SdkCallOptions): Promise; /** * Returns session information for a specified bot, alias, and user. For example, you can use this operation to retrieve session information for a user that has left a long-running session in use. If the bot, alias, or session identifier doesn't exist, Amazon Lex V2 returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException. */ getSession(input: AWS.LexRuntimeV2.GetSessionRequest, options: SdkCallOptions): Promise; /** * Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot. */ putSession(input: AWS.LexRuntimeV2.PutSessionRequest, options: SdkCallOptions): Promise; /** * Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot. In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display. If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification. Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present. Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message. Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out. For more information, see Completion message. */ recognizeText(input: AWS.LexRuntimeV2.RecognizeTextRequest, options: SdkCallOptions): Promise; /** * Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot. The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2. requestAttributes sessionState The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them. inputTranscript interpretations messages requestAttributes sessionState The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2. If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification. Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present. Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message. Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out. For more information, see Completion message. */ recognizeUtterance(input: AWS.LexRuntimeV2.RecognizeUtteranceRequest, options: SdkCallOptions): Promise; } export interface LicenseManager { /** * Accepts the specified grant. */ acceptGrant(input: AWS.LicenseManager.AcceptGrantRequest, options: SdkCallOptions): Promise; /** * Checks in the specified license. Check in a license when it is no longer in use. */ checkInLicense(input: AWS.LicenseManager.CheckInLicenseRequest, options: SdkCallOptions): Promise; /** * Checks out the specified license for offline use. */ checkoutBorrowLicense(input: AWS.LicenseManager.CheckoutBorrowLicenseRequest, options: SdkCallOptions): Promise; /** * Checks out the specified license. */ checkoutLicense(input: AWS.LicenseManager.CheckoutLicenseRequest, options: SdkCallOptions): Promise; /** * Creates a grant for the specified license. A grant shares the use of license entitlements with specific Amazon Web Services accounts. */ createGrant(input: AWS.LicenseManager.CreateGrantRequest, options: SdkCallOptions): Promise; /** * Creates a new version of the specified grant. */ createGrantVersion(input: AWS.LicenseManager.CreateGrantVersionRequest, options: SdkCallOptions): Promise; /** * Creates a license. */ createLicense(input: AWS.LicenseManager.CreateLicenseRequest, options: SdkCallOptions): Promise; /** * Creates a license configuration. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used. */ createLicenseConfiguration(input: AWS.LicenseManager.CreateLicenseConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a new license conversion task. */ createLicenseConversionTaskForResource(input: AWS.LicenseManager.CreateLicenseConversionTaskForResourceRequest, options: SdkCallOptions): Promise; /** * Creates a report generator. */ createLicenseManagerReportGenerator(input: AWS.LicenseManager.CreateLicenseManagerReportGeneratorRequest, options: SdkCallOptions): Promise; /** * Creates a new version of the specified license. */ createLicenseVersion(input: AWS.LicenseManager.CreateLicenseVersionRequest, options: SdkCallOptions): Promise; /** * Creates a long-lived token. A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license. */ createToken(input: AWS.LicenseManager.CreateTokenRequest, options: SdkCallOptions): Promise; /** * Deletes the specified grant. */ deleteGrant(input: AWS.LicenseManager.DeleteGrantRequest, options: SdkCallOptions): Promise; /** * Deletes the specified license. */ deleteLicense(input: AWS.LicenseManager.DeleteLicenseRequest, options: SdkCallOptions): Promise; /** * Deletes the specified license configuration. You cannot delete a license configuration that is in use. */ deleteLicenseConfiguration(input: AWS.LicenseManager.DeleteLicenseConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified report generator. This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator. */ deleteLicenseManagerReportGenerator(input: AWS.LicenseManager.DeleteLicenseManagerReportGeneratorRequest, options: SdkCallOptions): Promise; /** * Deletes the specified token. Must be called in the license home Region. */ deleteToken(input: AWS.LicenseManager.DeleteTokenRequest, options: SdkCallOptions): Promise; /** * Extends the expiration date for license consumption. */ extendLicenseConsumption(input: AWS.LicenseManager.ExtendLicenseConsumptionRequest, options: SdkCallOptions): Promise; /** * Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour. */ getAccessToken(input: AWS.LicenseManager.GetAccessTokenRequest, options: SdkCallOptions): Promise; /** * Gets detailed information about the specified grant. */ getGrant(input: AWS.LicenseManager.GetGrantRequest, options: SdkCallOptions): Promise; /** * Gets detailed information about the specified license. */ getLicense(input: AWS.LicenseManager.GetLicenseRequest, options: SdkCallOptions): Promise; /** * Gets detailed information about the specified license configuration. */ getLicenseConfiguration(input: AWS.LicenseManager.GetLicenseConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified license type conversion task. */ getLicenseConversionTask(input: AWS.LicenseManager.GetLicenseConversionTaskRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified report generator. */ getLicenseManagerReportGenerator(input: AWS.LicenseManager.GetLicenseManagerReportGeneratorRequest, options: SdkCallOptions): Promise; /** * Gets detailed information about the usage of the specified license. */ getLicenseUsage(input: AWS.LicenseManager.GetLicenseUsageRequest, options: SdkCallOptions): Promise; /** * Gets the License Manager settings for the current Region. */ getServiceSettings(input: AWS.LicenseManager.GetServiceSettingsRequest, options: SdkCallOptions): Promise; /** * Lists the resource associations for the specified license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules). */ listAssociationsForLicenseConfiguration(input: AWS.LicenseManager.ListAssociationsForLicenseConfigurationRequest, options: SdkCallOptions): Promise; /** * Lists the grants distributed for the specified license. */ listDistributedGrants(input: AWS.LicenseManager.ListDistributedGrantsRequest, options: SdkCallOptions): Promise; /** * Lists the license configuration operations that failed. */ listFailuresForLicenseConfigurationOperations(input: AWS.LicenseManager.ListFailuresForLicenseConfigurationOperationsRequest, options: SdkCallOptions): Promise; /** * Lists the license configurations for your account. */ listLicenseConfigurations(input: AWS.LicenseManager.ListLicenseConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists the license type conversion tasks for your account. */ listLicenseConversionTasks(input: AWS.LicenseManager.ListLicenseConversionTasksRequest, options: SdkCallOptions): Promise; /** * Lists the report generators for your account. */ listLicenseManagerReportGenerators(input: AWS.LicenseManager.ListLicenseManagerReportGeneratorsRequest, options: SdkCallOptions): Promise; /** * Describes the license configurations for the specified resource. */ listLicenseSpecificationsForResource(input: AWS.LicenseManager.ListLicenseSpecificationsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists all versions of the specified license. */ listLicenseVersions(input: AWS.LicenseManager.ListLicenseVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the licenses for your account. */ listLicenses(input: AWS.LicenseManager.ListLicensesRequest, options: SdkCallOptions): Promise; /** * Lists grants that are received but not accepted. */ listReceivedGrants(input: AWS.LicenseManager.ListReceivedGrantsRequest, options: SdkCallOptions): Promise; /** * Lists received licenses. */ listReceivedLicenses(input: AWS.LicenseManager.ListReceivedLicensesRequest, options: SdkCallOptions): Promise; /** * Lists resources managed using Systems Manager inventory. */ listResourceInventory(input: AWS.LicenseManager.ListResourceInventoryRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified license configuration. */ listTagsForResource(input: AWS.LicenseManager.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists your tokens. */ listTokens(input: AWS.LicenseManager.ListTokensRequest, options: SdkCallOptions): Promise; /** * Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration. */ listUsageForLicenseConfiguration(input: AWS.LicenseManager.ListUsageForLicenseConfigurationRequest, options: SdkCallOptions): Promise; /** * Rejects the specified grant. */ rejectGrant(input: AWS.LicenseManager.RejectGrantRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified license configuration. */ tagResource(input: AWS.LicenseManager.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified license configuration. */ untagResource(input: AWS.LicenseManager.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Modifies the attributes of an existing license configuration. */ updateLicenseConfiguration(input: AWS.LicenseManager.UpdateLicenseConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates a report generator. After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated. */ updateLicenseManagerReportGenerator(input: AWS.LicenseManager.UpdateLicenseManagerReportGeneratorRequest, options: SdkCallOptions): Promise; /** * Adds or removes the specified license configurations for the specified Amazon Web Services resource. You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and CloudFormation templates, as they send license configurations to the operation that creates the resource. */ updateLicenseSpecificationsForResource(input: AWS.LicenseManager.UpdateLicenseSpecificationsForResourceRequest, options: SdkCallOptions): Promise; /** * Updates License Manager settings for the current Region. */ updateServiceSettings(input: AWS.LicenseManager.UpdateServiceSettingsRequest, options: SdkCallOptions): Promise; } export interface LicenseManagerUserSubscriptions { /** * Associates the user to an EC2 instance to utilize user-based subscriptions. */ associateUser(input: AWS.LicenseManagerUserSubscriptions.AssociateUserRequest, options: SdkCallOptions): Promise; /** * Deregisters the identity provider from providing user-based subscriptions. */ deregisterIdentityProvider(input: AWS.LicenseManagerUserSubscriptions.DeregisterIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Disassociates the user from an EC2 instance providing user-based subscriptions. */ disassociateUser(input: AWS.LicenseManagerUserSubscriptions.DisassociateUserRequest, options: SdkCallOptions): Promise; /** * Lists the identity providers for user-based subscriptions. */ listIdentityProviders(input: AWS.LicenseManagerUserSubscriptions.ListIdentityProvidersRequest, options: SdkCallOptions): Promise; /** * Lists the EC2 instances providing user-based subscriptions. */ listInstances(input: AWS.LicenseManagerUserSubscriptions.ListInstancesRequest, options: SdkCallOptions): Promise; /** * Lists the user-based subscription products available from an identity provider. */ listProductSubscriptions(input: AWS.LicenseManagerUserSubscriptions.ListProductSubscriptionsRequest, options: SdkCallOptions): Promise; /** * Lists user associations for an identity provider. */ listUserAssociations(input: AWS.LicenseManagerUserSubscriptions.ListUserAssociationsRequest, options: SdkCallOptions): Promise; /** * Registers an identity provider for user-based subscriptions. */ registerIdentityProvider(input: AWS.LicenseManagerUserSubscriptions.RegisterIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Starts a product subscription for a user with the specified identity provider. */ startProductSubscription(input: AWS.LicenseManagerUserSubscriptions.StartProductSubscriptionRequest, options: SdkCallOptions): Promise; /** * Stops a product subscription for a user with the specified identity provider. */ stopProductSubscription(input: AWS.LicenseManagerUserSubscriptions.StopProductSubscriptionRequest, options: SdkCallOptions): Promise; } export interface Lightsail { /** * Allocates a static IP address. */ allocateStaticIp(input: AWS.Lightsail.AllocateStaticIpRequest, options: SdkCallOptions): Promise; /** * Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate. Use the CreateCertificate action to create a certificate that you can attach to your distribution. Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region. */ attachCertificateToDistribution(input: AWS.Lightsail.AttachCertificateToDistributionRequest, options: SdkCallOptions): Promise; /** * Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name. The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide. */ attachDisk(input: AWS.Lightsail.AttachDiskRequest, options: SdkCallOptions): Promise; /** * Attaches one or more Lightsail instances to a load balancer. After some time, the instances are attached to the load balancer and the health check status is available. The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide. */ attachInstancesToLoadBalancer(input: AWS.Lightsail.AttachInstancesToLoadBalancerRequest, options: SdkCallOptions): Promise; /** * Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide. */ attachLoadBalancerTlsCertificate(input: AWS.Lightsail.AttachLoadBalancerTlsCertificateRequest, options: SdkCallOptions): Promise; /** * Attaches a static IP address to a specific Amazon Lightsail instance. */ attachStaticIp(input: AWS.Lightsail.AttachStaticIpRequest, options: SdkCallOptions): Promise; /** * Closes ports for a specific Amazon Lightsail instance. The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide. */ closeInstancePublicPorts(input: AWS.Lightsail.CloseInstancePublicPortsRequest, options: SdkCallOptions): Promise; /** * Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail. When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters. When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters. */ copySnapshot(input: AWS.Lightsail.CopySnapshotRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Lightsail bucket. A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide. */ createBucket(input: AWS.Lightsail.CreateBucketRequest, options: SdkCallOptions): Promise; /** * Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key. Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key. */ createBucketAccessKey(input: AWS.Lightsail.CreateBucketAccessKeyRequest, options: SdkCallOptions): Promise; /** * Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service. After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service. Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region. */ createCertificate(input: AWS.Lightsail.CreateCertificateRequest, options: SdkCallOptions): Promise; /** * Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record. */ createCloudFormationStack(input: AWS.Lightsail.CreateCloudFormationStackRequest, options: SdkCallOptions): Promise; /** * Creates an email or SMS text message contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail. */ createContactMethod(input: AWS.Lightsail.CreateContactMethodRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Lightsail container service. A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide. */ createContainerService(input: AWS.Lightsail.CreateContainerServiceRequest, options: SdkCallOptions): Promise; /** * Creates a deployment for your Amazon Lightsail container service. A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration. You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide. */ createContainerServiceDeployment(input: AWS.Lightsail.CreateContainerServiceDeploymentRequest, options: SdkCallOptions): Promise; /** * Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials. You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry. After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service. This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide. */ createContainerServiceRegistryLogin(input: AWS.Lightsail.CreateContainerServiceRegistryLoginRequest, options: SdkCallOptions): Promise; /** * Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. */ createDisk(input: AWS.Lightsail.CreateDiskRequest, options: SdkCallOptions): Promise; /** * Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide. */ createDiskFromSnapshot(input: AWS.Lightsail.CreateDiskFromSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending. You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk. The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. */ createDiskSnapshot(input: AWS.Lightsail.CreateDiskSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Lightsail content delivery network (CDN) distribution. A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail. */ createDistribution(input: AWS.Lightsail.CreateDistributionRequest, options: SdkCallOptions): Promise; /** * Creates a domain resource for the specified domain (e.g., example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. */ createDomain(input: AWS.Lightsail.CreateDomainRequest, options: SdkCallOptions): Promise; /** * Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide. */ createDomainEntry(input: AWS.Lightsail.CreateDomainEntryRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot. The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. */ createInstanceSnapshot(input: AWS.Lightsail.CreateInstanceSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates one or more Amazon Lightsail instances. The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide. */ createInstances(input: AWS.Lightsail.CreateInstancesRequest, options: SdkCallOptions): Promise; /** * Creates one or more new instances from a manual or automatic snapshot of an instance. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide. */ createInstancesFromSnapshot(input: AWS.Lightsail.CreateInstancesFromSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates a custom SSH key pair that you can use with an Amazon Lightsail instance. Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist. The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. */ createKeyPair(input: AWS.Lightsail.CreateKeyPairRequest, options: SdkCallOptions): Promise; /** * Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account. When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation. The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. */ createLoadBalancer(input: AWS.Lightsail.CreateLoadBalancerRequest, options: SdkCallOptions): Promise; /** * Creates an SSL/TLS certificate for an Amazon Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide. */ createLoadBalancerTlsCertificate(input: AWS.Lightsail.CreateLoadBalancerTlsCertificateRequest, options: SdkCallOptions): Promise; /** * Creates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. */ createRelationalDatabase(input: AWS.Lightsail.CreateRelationalDatabaseRequest, options: SdkCallOptions): Promise; /** * Creates a new database from an existing database snapshot in Amazon Lightsail. You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan. The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide. */ createRelationalDatabaseFromSnapshot(input: AWS.Lightsail.CreateRelationalDatabaseFromSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. */ createRelationalDatabaseSnapshot(input: AWS.Lightsail.CreateRelationalDatabaseSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes an alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. */ deleteAlarm(input: AWS.Lightsail.DeleteAlarmRequest, options: SdkCallOptions): Promise; /** * Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide. */ deleteAutoSnapshot(input: AWS.Lightsail.DeleteAutoSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes a Amazon Lightsail bucket. When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account. */ deleteBucket(input: AWS.Lightsail.DeleteBucketRequest, options: SdkCallOptions): Promise; /** * Deletes an access key for the specified Amazon Lightsail bucket. We recommend that you delete an access key if the secret access key is compromised. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. */ deleteBucketAccessKey(input: AWS.Lightsail.DeleteBucketAccessKeyRequest, options: SdkCallOptions): Promise; /** * Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution. Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution. */ deleteCertificate(input: AWS.Lightsail.DeleteCertificateRequest, options: SdkCallOptions): Promise; /** * Deletes a contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail. */ deleteContactMethod(input: AWS.Lightsail.DeleteContactMethodRequest, options: SdkCallOptions): Promise; /** * Deletes a container image that is registered to your Amazon Lightsail container service. */ deleteContainerImage(input: AWS.Lightsail.DeleteContainerImageRequest, options: SdkCallOptions): Promise; /** * Deletes your Amazon Lightsail container service. */ deleteContainerService(input: AWS.Lightsail.DeleteContainerServiceRequest, options: SdkCallOptions): Promise; /** * Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide. */ deleteDisk(input: AWS.Lightsail.DeleteDiskRequest, options: SdkCallOptions): Promise; /** * Deletes the specified disk snapshot. When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk. The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide. */ deleteDiskSnapshot(input: AWS.Lightsail.DeleteDiskSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes your Amazon Lightsail content delivery network (CDN) distribution. */ deleteDistribution(input: AWS.Lightsail.DeleteDistributionRequest, options: SdkCallOptions): Promise; /** * Deletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide. */ deleteDomain(input: AWS.Lightsail.DeleteDomainRequest, options: SdkCallOptions): Promise; /** * Deletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide. */ deleteDomainEntry(input: AWS.Lightsail.DeleteDomainEntryRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Lightsail instance. The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide. */ deleteInstance(input: AWS.Lightsail.DeleteInstanceRequest, options: SdkCallOptions): Promise; /** * Deletes a specific snapshot of a virtual private server (or instance). The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide. */ deleteInstanceSnapshot(input: AWS.Lightsail.DeleteInstanceSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes the specified key pair by removing the public key from Amazon Lightsail. You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API. The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Amazon Lightsail Developer Guide. */ deleteKeyPair(input: AWS.Lightsail.DeleteKeyPairRequest, options: SdkCallOptions): Promise; /** * Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch. Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client. */ deleteKnownHostKeys(input: AWS.Lightsail.DeleteKnownHostKeysRequest, options: SdkCallOptions): Promise; /** * Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again. The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide. */ deleteLoadBalancer(input: AWS.Lightsail.DeleteLoadBalancerRequest, options: SdkCallOptions): Promise; /** * Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide. */ deleteLoadBalancerTlsCertificate(input: AWS.Lightsail.DeleteLoadBalancerTlsCertificateRequest, options: SdkCallOptions): Promise; /** * Deletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. */ deleteRelationalDatabase(input: AWS.Lightsail.DeleteRelationalDatabaseRequest, options: SdkCallOptions): Promise; /** * Deletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. */ deleteRelationalDatabaseSnapshot(input: AWS.Lightsail.DeleteRelationalDatabaseSnapshotRequest, options: SdkCallOptions): Promise; /** * Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate. */ detachCertificateFromDistribution(input: AWS.Lightsail.DetachCertificateFromDistributionRequest, options: SdkCallOptions): Promise; /** * Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk. The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide. */ detachDisk(input: AWS.Lightsail.DetachDiskRequest, options: SdkCallOptions): Promise; /** * Detaches the specified instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from the load balancer. The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide. */ detachInstancesFromLoadBalancer(input: AWS.Lightsail.DetachInstancesFromLoadBalancerRequest, options: SdkCallOptions): Promise; /** * Detaches a static IP from the Amazon Lightsail instance to which it is attached. */ detachStaticIp(input: AWS.Lightsail.DetachStaticIpRequest, options: SdkCallOptions): Promise; /** * Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide. */ disableAddOn(input: AWS.Lightsail.DisableAddOnRequest, options: SdkCallOptions): Promise; /** * Downloads the regional Amazon Lightsail default key pair. This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region. */ downloadDefaultKeyPair(input: AWS.Lightsail.DownloadDefaultKeyPairRequest, options: SdkCallOptions): Promise; /** * Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide. */ enableAddOn(input: AWS.Lightsail.EnableAddOnRequest, options: SdkCallOptions): Promise; /** * Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances. Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Amazon Lightsail Developer Guide. Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2. */ exportSnapshot(input: AWS.Lightsail.ExportSnapshotRequest, options: SdkCallOptions): Promise; /** * Returns the names of all active (not deleted) resources. */ getActiveNames(input: AWS.Lightsail.GetActiveNamesRequest, options: SdkCallOptions): Promise; /** * Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. */ getAlarms(input: AWS.Lightsail.GetAlarmsRequest, options: SdkCallOptions): Promise; /** * Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide. */ getAutoSnapshots(input: AWS.Lightsail.GetAutoSnapshotsRequest, options: SdkCallOptions): Promise; /** * Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. */ getBlueprints(input: AWS.Lightsail.GetBlueprintsRequest, options: SdkCallOptions): Promise; /** * Returns the existing access key IDs for the specified Amazon Lightsail bucket. This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key. */ getBucketAccessKeys(input: AWS.Lightsail.GetBucketAccessKeysRequest, options: SdkCallOptions): Promise; /** * Returns the bundles that you can apply to a Amazon Lightsail bucket. The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket. Use the UpdateBucketBundle action to update the bundle for a bucket. */ getBucketBundles(input: AWS.Lightsail.GetBucketBundlesRequest, options: SdkCallOptions): Promise; /** * Returns the data points of a specific metric for an Amazon Lightsail bucket. Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects. */ getBucketMetricData(input: AWS.Lightsail.GetBucketMetricDataRequest, options: SdkCallOptions): Promise; /** * Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide. */ getBuckets(input: AWS.Lightsail.GetBucketsRequest, options: SdkCallOptions): Promise; /** * Returns the bundles that you can apply to an Amazon Lightsail instance when you create it. A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota. Bundles are referred to as instance plans in the Lightsail console. */ getBundles(input: AWS.Lightsail.GetBundlesRequest, options: SdkCallOptions): Promise; /** * Returns information about one or more Amazon Lightsail SSL/TLS certificates. To get a summary of a certificate, ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags. */ getCertificates(input: AWS.Lightsail.GetCertificatesRequest, options: SdkCallOptions): Promise; /** * Returns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot. */ getCloudFormationStackRecords(input: AWS.Lightsail.GetCloudFormationStackRecordsRequest, options: SdkCallOptions): Promise; /** * Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail. */ getContactMethods(input: AWS.Lightsail.GetContactMethodsRequest, options: SdkCallOptions): Promise; /** * Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin. */ getContainerAPIMetadata(input: AWS.Lightsail.GetContainerAPIMetadataRequest, options: SdkCallOptions): Promise; /** * Returns the container images that are registered to your Amazon Lightsail container service. If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service. */ getContainerImages(input: AWS.Lightsail.GetContainerImagesRequest, options: SdkCallOptions): Promise; /** * Returns the log events of a container of your Amazon Lightsail container service. If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service. Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference. */ getContainerLog(input: AWS.Lightsail.GetContainerLogRequest, options: SdkCallOptions): Promise; /** * Returns the deployments for your Amazon Lightsail container service A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service. The deployments are ordered by version in ascending order. The newest version is listed at the top of the response. A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference. */ getContainerServiceDeployments(input: AWS.Lightsail.GetContainerServiceDeploymentsRequest, options: SdkCallOptions): Promise; /** * Returns the data points of a specific metric of your Amazon Lightsail container service. Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. */ getContainerServiceMetricData(input: AWS.Lightsail.GetContainerServiceMetricDataRequest, options: SdkCallOptions): Promise; /** * Returns the list of powers that can be specified for your Amazon Lightsail container services. The power specifies the amount of memory, the number of vCPUs, and the base price of the container service. */ getContainerServicePowers(input: AWS.Lightsail.GetContainerServicePowersRequest, options: SdkCallOptions): Promise; /** * Returns information about one or more of your Amazon Lightsail container services. */ getContainerServices(input: AWS.Lightsail.GetContainerServicesRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific block storage disk. */ getDisk(input: AWS.Lightsail.GetDiskRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific block storage disk snapshot. */ getDiskSnapshot(input: AWS.Lightsail.GetDiskSnapshotRequest, options: SdkCallOptions): Promise; /** * Returns information about all block storage disk snapshots in your AWS account and region. */ getDiskSnapshots(input: AWS.Lightsail.GetDiskSnapshotsRequest, options: SdkCallOptions): Promise; /** * Returns information about all block storage disks in your AWS account and region. */ getDisks(input: AWS.Lightsail.GetDisksRequest, options: SdkCallOptions): Promise; /** * Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions. A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution. */ getDistributionBundles(input: AWS.Lightsail.GetDistributionBundlesRequest, options: SdkCallOptions): Promise; /** * Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution. */ getDistributionLatestCacheReset(input: AWS.Lightsail.GetDistributionLatestCacheResetRequest, options: SdkCallOptions): Promise; /** * Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. */ getDistributionMetricData(input: AWS.Lightsail.GetDistributionMetricDataRequest, options: SdkCallOptions): Promise; /** * Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions. */ getDistributions(input: AWS.Lightsail.GetDistributionsRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific domain recordset. */ getDomain(input: AWS.Lightsail.GetDomainRequest, options: SdkCallOptions): Promise; /** * Returns a list of all domains in the user's account. */ getDomains(input: AWS.Lightsail.GetDomainsRequest, options: SdkCallOptions): Promise; /** * Returns all export snapshot records created as a result of the export snapshot operation. An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the CreateCloudFormationStack action. */ getExportSnapshotRecords(input: AWS.Lightsail.GetExportSnapshotRecordsRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific Amazon Lightsail instance, which is a virtual private server. */ getInstance(input: AWS.Lightsail.GetInstanceRequest, options: SdkCallOptions): Promise; /** * Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance. The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide. */ getInstanceAccessDetails(input: AWS.Lightsail.GetInstanceAccessDetailsRequest, options: SdkCallOptions): Promise; /** * Returns the data points for the specified Amazon Lightsail instance metric, given an instance name. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. */ getInstanceMetricData(input: AWS.Lightsail.GetInstanceMetricDataRequest, options: SdkCallOptions): Promise; /** * Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol. */ getInstancePortStates(input: AWS.Lightsail.GetInstancePortStatesRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific instance snapshot. */ getInstanceSnapshot(input: AWS.Lightsail.GetInstanceSnapshotRequest, options: SdkCallOptions): Promise; /** * Returns all instance snapshots for the user's account. */ getInstanceSnapshots(input: AWS.Lightsail.GetInstanceSnapshotsRequest, options: SdkCallOptions): Promise; /** * Returns the state of a specific instance. Works on one instance at a time. */ getInstanceState(input: AWS.Lightsail.GetInstanceStateRequest, options: SdkCallOptions): Promise; /** * Returns information about all Amazon Lightsail virtual private servers, or instances. */ getInstances(input: AWS.Lightsail.GetInstancesRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific key pair. */ getKeyPair(input: AWS.Lightsail.GetKeyPairRequest, options: SdkCallOptions): Promise; /** * Returns information about all key pairs in the user's account. */ getKeyPairs(input: AWS.Lightsail.GetKeyPairsRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified Lightsail load balancer. */ getLoadBalancer(input: AWS.Lightsail.GetLoadBalancerRequest, options: SdkCallOptions): Promise; /** * Returns information about health metrics for your Lightsail load balancer. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. */ getLoadBalancerMetricData(input: AWS.Lightsail.GetLoadBalancerMetricDataRequest, options: SdkCallOptions): Promise; /** * Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive. */ getLoadBalancerTlsCertificates(input: AWS.Lightsail.GetLoadBalancerTlsCertificatesRequest, options: SdkCallOptions): Promise; /** * Returns a list of TLS security policies that you can apply to Lightsail load balancers. For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide. */ getLoadBalancerTlsPolicies(input: AWS.Lightsail.GetLoadBalancerTlsPoliciesRequest, options: SdkCallOptions): Promise; /** * Returns information about all load balancers in an account. */ getLoadBalancers(input: AWS.Lightsail.GetLoadBalancersRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on. */ getOperation(input: AWS.Lightsail.GetOperationRequest, options: SdkCallOptions): Promise; /** * Returns information about all operations. Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request. */ getOperations(input: AWS.Lightsail.GetOperationsRequest, options: SdkCallOptions): Promise; /** * Gets operations for a specific resource (e.g., an instance or a static IP). */ getOperationsForResource(input: AWS.Lightsail.GetOperationsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region. */ getRegions(input: AWS.Lightsail.GetRegionsRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific database in Amazon Lightsail. */ getRelationalDatabase(input: AWS.Lightsail.GetRelationalDatabaseRequest, options: SdkCallOptions): Promise; /** * Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. You can use a blueprint ID to create a new database that runs a specific database engine. */ getRelationalDatabaseBlueprints(input: AWS.Lightsail.GetRelationalDatabaseBlueprintsRequest, options: SdkCallOptions): Promise; /** * Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database. You can use a bundle ID to create a new database with explicit performance specifications. */ getRelationalDatabaseBundles(input: AWS.Lightsail.GetRelationalDatabaseBundlesRequest, options: SdkCallOptions): Promise; /** * Returns a list of events for a specific database in Amazon Lightsail. */ getRelationalDatabaseEvents(input: AWS.Lightsail.GetRelationalDatabaseEventsRequest, options: SdkCallOptions): Promise; /** * Returns a list of log events for a database in Amazon Lightsail. */ getRelationalDatabaseLogEvents(input: AWS.Lightsail.GetRelationalDatabaseLogEventsRequest, options: SdkCallOptions): Promise; /** * Returns a list of available log streams for a specific database in Amazon Lightsail. */ getRelationalDatabaseLogStreams(input: AWS.Lightsail.GetRelationalDatabaseLogStreamsRequest, options: SdkCallOptions): Promise; /** * Returns the current, previous, or pending versions of the master user password for a Lightsail database. The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. */ getRelationalDatabaseMasterUserPassword(input: AWS.Lightsail.GetRelationalDatabaseMasterUserPasswordRequest, options: SdkCallOptions): Promise; /** * Returns the data points of the specified metric for a database in Amazon Lightsail. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. */ getRelationalDatabaseMetricData(input: AWS.Lightsail.GetRelationalDatabaseMetricDataRequest, options: SdkCallOptions): Promise; /** * Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types. */ getRelationalDatabaseParameters(input: AWS.Lightsail.GetRelationalDatabaseParametersRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific database snapshot in Amazon Lightsail. */ getRelationalDatabaseSnapshot(input: AWS.Lightsail.GetRelationalDatabaseSnapshotRequest, options: SdkCallOptions): Promise; /** * Returns information about all of your database snapshots in Amazon Lightsail. */ getRelationalDatabaseSnapshots(input: AWS.Lightsail.GetRelationalDatabaseSnapshotsRequest, options: SdkCallOptions): Promise; /** * Returns information about all of your databases in Amazon Lightsail. */ getRelationalDatabases(input: AWS.Lightsail.GetRelationalDatabasesRequest, options: SdkCallOptions): Promise; /** * Returns information about an Amazon Lightsail static IP. */ getStaticIp(input: AWS.Lightsail.GetStaticIpRequest, options: SdkCallOptions): Promise; /** * Returns information about all static IPs in the user's account. */ getStaticIps(input: AWS.Lightsail.GetStaticIpsRequest, options: SdkCallOptions): Promise; /** * Imports a public SSH key from a specific key pair. */ importKeyPair(input: AWS.Lightsail.ImportKeyPairRequest, options: SdkCallOptions): Promise; /** * Returns a Boolean value indicating whether your Lightsail VPC is peered. */ isVpcPeered(input: AWS.Lightsail.IsVpcPeeredRequest, options: SdkCallOptions): Promise; /** * Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide. */ openInstancePublicPorts(input: AWS.Lightsail.OpenInstancePublicPortsRequest, options: SdkCallOptions): Promise; /** * Peers the Lightsail VPC with the user's default VPC. */ peerVpc(input: AWS.Lightsail.PeerVpcRequest, options: SdkCallOptions): Promise; /** * Creates or updates an alarm, and associates it with the specified metric. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration. */ putAlarm(input: AWS.Lightsail.PutAlarmRequest, options: SdkCallOptions): Promise; /** * Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports. The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide. */ putInstancePublicPorts(input: AWS.Lightsail.PutInstancePublicPortsRequest, options: SdkCallOptions): Promise; /** * Restarts a specific instance. The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide. */ rebootInstance(input: AWS.Lightsail.RebootInstanceRequest, options: SdkCallOptions): Promise; /** * Restarts a specific database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. */ rebootRelationalDatabase(input: AWS.Lightsail.RebootRelationalDatabaseRequest, options: SdkCallOptions): Promise; /** * Registers a container image to your Amazon Lightsail container service. This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide. */ registerContainerImage(input: AWS.Lightsail.RegisterContainerImageRequest, options: SdkCallOptions): Promise; /** * Deletes a specific static IP from your account. */ releaseStaticIp(input: AWS.Lightsail.ReleaseStaticIpRequest, options: SdkCallOptions): Promise; /** * Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution. After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin. */ resetDistributionCache(input: AWS.Lightsail.ResetDistributionCacheRequest, options: SdkCallOptions): Promise; /** * Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail. A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired. Notifications are not sent to an email contact method until after it is verified, and confirmed as valid. */ sendContactMethodVerification(input: AWS.Lightsail.SendContactMethodVerificationRequest, options: SdkCallOptions): Promise; /** * Sets the IP address type for an Amazon Lightsail resource. Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only. */ setIpAddressType(input: AWS.Lightsail.SetIpAddressTypeRequest, options: SdkCallOptions): Promise; /** * Sets the Amazon Lightsail resources that can access the specified Lightsail bucket. Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region. */ setResourceAccessForBucket(input: AWS.Lightsail.SetResourceAccessForBucketRequest, options: SdkCallOptions): Promise; /** * Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide. The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide. */ startInstance(input: AWS.Lightsail.StartInstanceRequest, options: SdkCallOptions): Promise; /** * Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. */ startRelationalDatabase(input: AWS.Lightsail.StartRelationalDatabaseRequest, options: SdkCallOptions): Promise; /** * Stops a specific Amazon Lightsail instance that is currently running. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide. The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide. */ stopInstance(input: AWS.Lightsail.StopInstanceRequest, options: SdkCallOptions): Promise; /** * Stops a specific database that is currently running in Amazon Lightsail. The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. */ stopRelationalDatabase(input: AWS.Lightsail.StopRelationalDatabaseRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide. The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide. */ tagResource(input: AWS.Lightsail.TagResourceRequest, options: SdkCallOptions): Promise; /** * Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. */ testAlarm(input: AWS.Lightsail.TestAlarmRequest, options: SdkCallOptions): Promise; /** * Unpeers the Lightsail VPC from the user's default VPC. */ unpeerVpc(input: AWS.Lightsail.UnpeerVpcRequest, options: SdkCallOptions): Promise; /** * Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide. */ untagResource(input: AWS.Lightsail.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing Amazon Lightsail bucket. Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket. */ updateBucket(input: AWS.Lightsail.UpdateBucketRequest, options: SdkCallOptions): Promise; /** * Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle. Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come. */ updateBucketBundle(input: AWS.Lightsail.UpdateBucketBundleRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names. */ updateContainerService(input: AWS.Lightsail.UpdateContainerServiceRequest, options: SdkCallOptions): Promise; /** * Updates an existing Amazon Lightsail content delivery network (CDN) distribution. Use this action to update the configuration of your existing distribution. */ updateDistribution(input: AWS.Lightsail.UpdateDistributionRequest, options: SdkCallOptions): Promise; /** * Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution. A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution. Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee. You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle. */ updateDistributionBundle(input: AWS.Lightsail.UpdateDistributionBundleRequest, options: SdkCallOptions): Promise; /** * Updates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide. */ updateDomainEntry(input: AWS.Lightsail.UpdateDomainEntryRequest, options: SdkCallOptions): Promise; /** * Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance or GetInstances API operation initially responds with a state of pending. After the parameter modifications are successfully applied, the state changes to applied in subsequent GetInstance or GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide. */ updateInstanceMetadataOptions(input: AWS.Lightsail.UpdateInstanceMetadataOptionsRequest, options: SdkCallOptions): Promise; /** * Updates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide. */ updateLoadBalancerAttribute(input: AWS.Lightsail.UpdateLoadBalancerAttributeRequest, options: SdkCallOptions): Promise; /** * Allows the update of one or more attributes of a database in Amazon Lightsail. Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. */ updateRelationalDatabase(input: AWS.Lightsail.UpdateRelationalDatabaseRequest, options: SdkCallOptions): Promise; /** * Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. */ updateRelationalDatabaseParameters(input: AWS.Lightsail.UpdateRelationalDatabaseParametersRequest, options: SdkCallOptions): Promise; } export interface Location { /** * Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. You can associate up to five geofence collections to each tracker resource. Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account. */ associateTrackerConsumer(input: AWS.Location.AssociateTrackerConsumerRequest, options: SdkCallOptions): Promise; /** * Deletes the position history of one or more devices from a tracker resource. */ batchDeleteDevicePositionHistory(input: AWS.Location.BatchDeleteDevicePositionHistoryRequest, options: SdkCallOptions): Promise; /** * Deletes a batch of geofences from a geofence collection. This operation deletes the resource permanently. */ batchDeleteGeofence(input: AWS.Location.BatchDeleteGeofenceRequest, options: SdkCallOptions): Promise; /** * Evaluates device positions against the geofence geometries from a given geofence collection. This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge: ENTER if Amazon Location determines that the tracked device has entered a geofenced area. EXIT if Amazon Location determines that the tracked device has exited a geofenced area. The last geofence that a device was observed within is tracked for 30 days after the most recent device position update. Geofence evaluation uses the given device position. It does not account for the optional Accuracy of a DevicePositionUpdate. The DeviceID is used as a string to represent the device. You do not need to have a Tracker associated with the DeviceID. */ batchEvaluateGeofences(input: AWS.Location.BatchEvaluateGeofencesRequest, options: SdkCallOptions): Promise; /** * Lists the latest device positions for requested devices. */ batchGetDevicePosition(input: AWS.Location.BatchGetDevicePositionRequest, options: SdkCallOptions): Promise; /** * A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request. */ batchPutGeofence(input: AWS.Location.BatchPutGeofenceRequest, options: SdkCallOptions): Promise; /** * Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days. Position updates are handled based on the PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID. When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft). When PositionFiltering is set to AccuracyBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0} when accuracy is not provided on a DevicePositionUpdate. */ batchUpdateDevicePosition(input: AWS.Location.BatchUpdateDevicePositionRequest, options: SdkCallOptions): Promise; /** * Calculates a route given the following required parameters: DeparturePosition and DestinationPosition. Requires that you first create a route calculator resource. By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route. Additional options include: Specifying a departure time using either DepartureTime or DepartNow. This calculates a route based on predictive traffic data at the given time. You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error. Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck. If you specify walking for the travel mode and your data provider is Esri, the start and destination must be within 40km. */ calculateRoute(input: AWS.Location.CalculateRouteRequest, options: SdkCallOptions): Promise; /** * Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of DeparturePositions times the number of DestinationPositions. Your account is charged for each route calculated, not the number of requests. Requires that you first create a route calculator resource. By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes. Additional options include: Specifying a departure time using either DepartureTime or DepartNow. This calculates routes based on predictive traffic data at the given time. You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error. Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck. */ calculateRouteMatrix(input: AWS.Location.CalculateRouteMatrixRequest, options: SdkCallOptions): Promise; /** * Creates a geofence collection, which manages and stores geofences. */ createGeofenceCollection(input: AWS.Location.CreateGeofenceCollectionRequest, options: SdkCallOptions): Promise; /** * Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers. If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details. */ createMap(input: AWS.Location.CreateMapRequest, options: SdkCallOptions): Promise; /** * Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation. If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details. */ createPlaceIndex(input: AWS.Location.CreatePlaceIndexRequest, options: SdkCallOptions): Promise; /** * Creates a route calculator resource in your AWS account. You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider. If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details. */ createRouteCalculator(input: AWS.Location.CreateRouteCalculatorRequest, options: SdkCallOptions): Promise; /** * Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices. */ createTracker(input: AWS.Location.CreateTrackerRequest, options: SdkCallOptions): Promise; /** * Deletes a geofence collection from your AWS account. This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored. */ deleteGeofenceCollection(input: AWS.Location.DeleteGeofenceCollectionRequest, options: SdkCallOptions): Promise; /** * Deletes a map resource from your AWS account. This operation deletes the resource permanently. If the map is being used in an application, the map may not render. */ deleteMap(input: AWS.Location.DeleteMapRequest, options: SdkCallOptions): Promise; /** * Deletes a place index resource from your AWS account. This operation deletes the resource permanently. */ deletePlaceIndex(input: AWS.Location.DeletePlaceIndexRequest, options: SdkCallOptions): Promise; /** * Deletes a route calculator resource from your AWS account. This operation deletes the resource permanently. */ deleteRouteCalculator(input: AWS.Location.DeleteRouteCalculatorRequest, options: SdkCallOptions): Promise; /** * Deletes a tracker resource from your AWS account. This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications. */ deleteTracker(input: AWS.Location.DeleteTrackerRequest, options: SdkCallOptions): Promise; /** * Retrieves the geofence collection details. */ describeGeofenceCollection(input: AWS.Location.DescribeGeofenceCollectionRequest, options: SdkCallOptions): Promise; /** * Retrieves the map resource details. */ describeMap(input: AWS.Location.DescribeMapRequest, options: SdkCallOptions): Promise; /** * Retrieves the place index resource details. */ describePlaceIndex(input: AWS.Location.DescribePlaceIndexRequest, options: SdkCallOptions): Promise; /** * Retrieves the route calculator resource details. */ describeRouteCalculator(input: AWS.Location.DescribeRouteCalculatorRequest, options: SdkCallOptions): Promise; /** * Retrieves the tracker resource details. */ describeTracker(input: AWS.Location.DescribeTrackerRequest, options: SdkCallOptions): Promise; /** * Removes the association between a tracker resource and a geofence collection. Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences. */ disassociateTrackerConsumer(input: AWS.Location.DisassociateTrackerConsumerRequest, options: SdkCallOptions): Promise; /** * Retrieves a device's most recent position according to its sample time. Device positions are deleted after 30 days. */ getDevicePosition(input: AWS.Location.GetDevicePositionRequest, options: SdkCallOptions): Promise; /** * Retrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after 30 days. */ getDevicePositionHistory(input: AWS.Location.GetDevicePositionHistoryRequest, options: SdkCallOptions): Promise; /** * Retrieves the geofence details from a geofence collection. */ getGeofence(input: AWS.Location.GetGeofenceRequest, options: SdkCallOptions): Promise; /** * Retrieves glyphs used to display labels on a map. */ getMapGlyphs(input: AWS.Location.GetMapGlyphsRequest, options: SdkCallOptions): Promise; /** * Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map. */ getMapSprites(input: AWS.Location.GetMapSpritesRequest, options: SdkCallOptions): Promise; /** * Retrieves the map style descriptor from a map resource. The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification. */ getMapStyleDescriptor(input: AWS.Location.GetMapStyleDescriptorRequest, options: SdkCallOptions): Promise; /** * Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1). */ getMapTile(input: AWS.Location.GetMapTileRequest, options: SdkCallOptions): Promise; /** * Finds a place by its unique ID. A PlaceId is returned by other search operations. A PlaceId is valid only if all of the following are the same in the original search request and the call to GetPlace. Customer AWS account AWS Region Data provider specified in the place index resource */ getPlace(input: AWS.Location.GetPlaceRequest, options: SdkCallOptions): Promise; /** * A batch request to retrieve all device positions. */ listDevicePositions(input: AWS.Location.ListDevicePositionsRequest, options: SdkCallOptions): Promise; /** * Lists geofence collections in your AWS account. */ listGeofenceCollections(input: AWS.Location.ListGeofenceCollectionsRequest, options: SdkCallOptions): Promise; /** * Lists geofences stored in a given geofence collection. */ listGeofences(input: AWS.Location.ListGeofencesRequest, options: SdkCallOptions): Promise; /** * Lists map resources in your AWS account. */ listMaps(input: AWS.Location.ListMapsRequest, options: SdkCallOptions): Promise; /** * Lists place index resources in your AWS account. */ listPlaceIndexes(input: AWS.Location.ListPlaceIndexesRequest, options: SdkCallOptions): Promise; /** * Lists route calculator resources in your AWS account. */ listRouteCalculators(input: AWS.Location.ListRouteCalculatorsRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags that are applied to the specified Amazon Location resource. */ listTagsForResource(input: AWS.Location.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists geofence collections currently associated to the given tracker resource. */ listTrackerConsumers(input: AWS.Location.ListTrackerConsumersRequest, options: SdkCallOptions): Promise; /** * Lists tracker resources in your AWS account. */ listTrackers(input: AWS.Location.ListTrackersRequest, options: SdkCallOptions): Promise; /** * Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request. */ putGeofence(input: AWS.Location.PutGeofenceRequest, options: SdkCallOptions): Promise; /** * Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position. */ searchPlaceIndexForPosition(input: AWS.Location.SearchPlaceIndexForPositionRequest, options: SdkCallOptions): Promise; /** * Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching. Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe. You can search for suggested place names near a specified position by using BiasPosition, or filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error. */ searchPlaceIndexForSuggestions(input: AWS.Location.SearchPlaceIndexForSuggestionsRequest, options: SdkCallOptions): Promise; /** * Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest. Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe. You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error. Search results are returned in order of highest to lowest relevance. */ searchPlaceIndexForText(input: AWS.Location.SearchPlaceIndexForTextRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource. <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p> */ tagResource(input: AWS.Location.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified Amazon Location resource. */ untagResource(input: AWS.Location.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified properties of a given geofence collection. */ updateGeofenceCollection(input: AWS.Location.UpdateGeofenceCollectionRequest, options: SdkCallOptions): Promise; /** * Updates the specified properties of a given map resource. */ updateMap(input: AWS.Location.UpdateMapRequest, options: SdkCallOptions): Promise; /** * Updates the specified properties of a given place index resource. */ updatePlaceIndex(input: AWS.Location.UpdatePlaceIndexRequest, options: SdkCallOptions): Promise; /** * Updates the specified properties for a given route calculator resource. */ updateRouteCalculator(input: AWS.Location.UpdateRouteCalculatorRequest, options: SdkCallOptions): Promise; /** * Updates the specified properties of a given tracker resource. */ updateTracker(input: AWS.Location.UpdateTrackerRequest, options: SdkCallOptions): Promise; } export interface LookoutEquipment { /** * Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. In other words, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data. */ createDataset(input: AWS.LookoutEquipment.CreateDatasetRequest, options: SdkCallOptions): Promise; /** * Creates a scheduled inference. Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data. */ createInferenceScheduler(input: AWS.LookoutEquipment.CreateInferenceSchedulerRequest, options: SdkCallOptions): Promise; /** * Creates a label for an event. */ createLabel(input: AWS.LookoutEquipment.CreateLabelRequest, options: SdkCallOptions): Promise; /** * Creates a group of labels. */ createLabelGroup(input: AWS.LookoutEquipment.CreateLabelGroupRequest, options: SdkCallOptions): Promise; /** * Creates an ML model for data inference. A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred. Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy. */ createModel(input: AWS.LookoutEquipment.CreateModelRequest, options: SdkCallOptions): Promise; /** * Deletes a dataset and associated artifacts. The operation will check to see if any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future. */ deleteDataset(input: AWS.LookoutEquipment.DeleteDatasetRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an inference scheduler that has been set up. Already processed output results are not affected. */ deleteInferenceScheduler(input: AWS.LookoutEquipment.DeleteInferenceSchedulerRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a label. */ deleteLabel(input: AWS.LookoutEquipment.DeleteLabelRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a group of labels. */ deleteLabelGroup(input: AWS.LookoutEquipment.DeleteLabelGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an ML model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up. */ deleteModel(input: AWS.LookoutEquipment.DeleteModelRequest, options: SdkCallOptions): Promise<{}>; /** * Provides information on a specific data ingestion job such as creation time, dataset ARN, and status. */ describeDataIngestionJob(input: AWS.LookoutEquipment.DescribeDataIngestionJobRequest, options: SdkCallOptions): Promise; /** * Provides a JSON description of the data in each time series dataset, including names, column names, and data types. */ describeDataset(input: AWS.LookoutEquipment.DescribeDatasetRequest, options: SdkCallOptions): Promise; /** * Specifies information about the inference scheduler being used, including name, model, status, and associated metadata */ describeInferenceScheduler(input: AWS.LookoutEquipment.DescribeInferenceSchedulerRequest, options: SdkCallOptions): Promise; /** * Returns the name of the label. */ describeLabel(input: AWS.LookoutEquipment.DescribeLabelRequest, options: SdkCallOptions): Promise; /** * Returns information about the label group. */ describeLabelGroup(input: AWS.LookoutEquipment.DescribeLabelGroupRequest, options: SdkCallOptions): Promise; /** * Provides a JSON containing the overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on. */ describeModel(input: AWS.LookoutEquipment.DescribeModelRequest, options: SdkCallOptions): Promise; /** * Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on. */ listDataIngestionJobs(input: AWS.LookoutEquipment.ListDataIngestionJobsRequest, options: SdkCallOptions): Promise; /** * Lists all datasets currently available in your account, filtering on the dataset name. */ listDatasets(input: AWS.LookoutEquipment.ListDatasetsRequest, options: SdkCallOptions): Promise; /** * Lists all inference events that have been found for the specified inference scheduler. */ listInferenceEvents(input: AWS.LookoutEquipment.ListInferenceEventsRequest, options: SdkCallOptions): Promise; /** * Lists all inference executions that have been performed by the specified inference scheduler. */ listInferenceExecutions(input: AWS.LookoutEquipment.ListInferenceExecutionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all inference schedulers currently available for your account. */ listInferenceSchedulers(input: AWS.LookoutEquipment.ListInferenceSchedulersRequest, options: SdkCallOptions): Promise; /** * Returns a list of the label groups. */ listLabelGroups(input: AWS.LookoutEquipment.ListLabelGroupsRequest, options: SdkCallOptions): Promise; /** * Provides a list of labels. */ listLabels(input: AWS.LookoutEquipment.ListLabelsRequest, options: SdkCallOptions): Promise; /** * Generates a list of all models in the account, including model name and ARN, dataset, and status. */ listModels(input: AWS.LookoutEquipment.ListModelsRequest, options: SdkCallOptions): Promise; /** * Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job. */ listSensorStatistics(input: AWS.LookoutEquipment.ListSensorStatisticsRequest, options: SdkCallOptions): Promise; /** * Lists all the tags for a specified resource, including key and value. */ listTagsForResource(input: AWS.LookoutEquipment.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts a data ingestion job. Amazon Lookout for Equipment returns the job status. */ startDataIngestionJob(input: AWS.LookoutEquipment.StartDataIngestionJobRequest, options: SdkCallOptions): Promise; /** * Starts an inference scheduler. */ startInferenceScheduler(input: AWS.LookoutEquipment.StartInferenceSchedulerRequest, options: SdkCallOptions): Promise; /** * Stops an inference scheduler. */ stopInferenceScheduler(input: AWS.LookoutEquipment.StopInferenceSchedulerRequest, options: SdkCallOptions): Promise; /** * Associates a given tag to a resource in your account. A tag is a key-value pair which can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your resources as well as helping you to search and filter by tag. Multiple tags can be added to a resource, either when you create it, or later. Up to 50 tags can be associated with each resource. */ tagResource(input: AWS.LookoutEquipment.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a specific tag from a given resource. The tag is specified by its key. */ untagResource(input: AWS.LookoutEquipment.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an inference scheduler. */ updateInferenceScheduler(input: AWS.LookoutEquipment.UpdateInferenceSchedulerRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the label group. */ updateLabelGroup(input: AWS.LookoutEquipment.UpdateLabelGroupRequest, options: SdkCallOptions): Promise<{}>; } export interface LookoutMetrics { /** * Activates an anomaly detector. */ activateAnomalyDetector(input: AWS.LookoutMetrics.ActivateAnomalyDetectorRequest, options: SdkCallOptions): Promise; /** * Runs a backtest for anomaly detection for the specified resource. */ backTestAnomalyDetector(input: AWS.LookoutMetrics.BackTestAnomalyDetectorRequest, options: SdkCallOptions): Promise; /** * Creates an alert for an anomaly detector. */ createAlert(input: AWS.LookoutMetrics.CreateAlertRequest, options: SdkCallOptions): Promise; /** * Creates an anomaly detector. */ createAnomalyDetector(input: AWS.LookoutMetrics.CreateAnomalyDetectorRequest, options: SdkCallOptions): Promise; /** * Creates a dataset. */ createMetricSet(input: AWS.LookoutMetrics.CreateMetricSetRequest, options: SdkCallOptions): Promise; /** * Deactivates an anomaly detector. */ deactivateAnomalyDetector(input: AWS.LookoutMetrics.DeactivateAnomalyDetectorRequest, options: SdkCallOptions): Promise; /** * Deletes an alert. */ deleteAlert(input: AWS.LookoutMetrics.DeleteAlertRequest, options: SdkCallOptions): Promise; /** * Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts. */ deleteAnomalyDetector(input: AWS.LookoutMetrics.DeleteAnomalyDetectorRequest, options: SdkCallOptions): Promise; /** * Describes an alert. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete. */ describeAlert(input: AWS.LookoutMetrics.DescribeAlertRequest, options: SdkCallOptions): Promise; /** * Returns information about the status of the specified anomaly detection jobs. */ describeAnomalyDetectionExecutions(input: AWS.LookoutMetrics.DescribeAnomalyDetectionExecutionsRequest, options: SdkCallOptions): Promise; /** * Describes a detector. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete. */ describeAnomalyDetector(input: AWS.LookoutMetrics.DescribeAnomalyDetectorRequest, options: SdkCallOptions): Promise; /** * Describes a dataset. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete. */ describeMetricSet(input: AWS.LookoutMetrics.DescribeMetricSetRequest, options: SdkCallOptions): Promise; /** * Detects an Amazon S3 dataset's file format, interval, and offset. */ detectMetricSetConfig(input: AWS.LookoutMetrics.DetectMetricSetConfigRequest, options: SdkCallOptions): Promise; /** * Returns details about a group of anomalous metrics. */ getAnomalyGroup(input: AWS.LookoutMetrics.GetAnomalyGroupRequest, options: SdkCallOptions): Promise; /** * Returns details about the requested data quality metrics. */ getDataQualityMetrics(input: AWS.LookoutMetrics.GetDataQualityMetricsRequest, options: SdkCallOptions): Promise; /** * Get feedback for an anomaly group. */ getFeedback(input: AWS.LookoutMetrics.GetFeedbackRequest, options: SdkCallOptions): Promise; /** * Returns a selection of sample records from an Amazon S3 datasource. */ getSampleData(input: AWS.LookoutMetrics.GetSampleDataRequest, options: SdkCallOptions): Promise; /** * Lists the alerts attached to a detector. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete. */ listAlerts(input: AWS.LookoutMetrics.ListAlertsRequest, options: SdkCallOptions): Promise; /** * Lists the detectors in the current AWS Region. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete. */ listAnomalyDetectors(input: AWS.LookoutMetrics.ListAnomalyDetectorsRequest, options: SdkCallOptions): Promise; /** * Returns a list of measures that are potential causes or effects of an anomaly group. */ listAnomalyGroupRelatedMetrics(input: AWS.LookoutMetrics.ListAnomalyGroupRelatedMetricsRequest, options: SdkCallOptions): Promise; /** * Returns a list of anomaly groups. */ listAnomalyGroupSummaries(input: AWS.LookoutMetrics.ListAnomalyGroupSummariesRequest, options: SdkCallOptions): Promise; /** * Gets a list of anomalous metrics for a measure in an anomaly group. */ listAnomalyGroupTimeSeries(input: AWS.LookoutMetrics.ListAnomalyGroupTimeSeriesRequest, options: SdkCallOptions): Promise; /** * Lists the datasets in the current AWS Region. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete. */ listMetricSets(input: AWS.LookoutMetrics.ListMetricSetsRequest, options: SdkCallOptions): Promise; /** * Gets a list of tags for a detector, dataset, or alert. */ listTagsForResource(input: AWS.LookoutMetrics.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Add feedback for an anomalous metric. */ putFeedback(input: AWS.LookoutMetrics.PutFeedbackRequest, options: SdkCallOptions): Promise; /** * Adds tags to a detector, dataset, or alert. */ tagResource(input: AWS.LookoutMetrics.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a detector, dataset, or alert. */ untagResource(input: AWS.LookoutMetrics.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Make changes to an existing alert. */ updateAlert(input: AWS.LookoutMetrics.UpdateAlertRequest, options: SdkCallOptions): Promise; /** * Updates a detector. After activation, you can only change a detector's ingestion delay and description. */ updateAnomalyDetector(input: AWS.LookoutMetrics.UpdateAnomalyDetectorRequest, options: SdkCallOptions): Promise; /** * Updates a dataset. */ updateMetricSet(input: AWS.LookoutMetrics.UpdateMetricSetRequest, options: SdkCallOptions): Promise; } export interface LookoutVision { /** * Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a training or a test dataset from a valid dataset source (DatasetSource). If you want a single dataset project, specify train for the value of DatasetType. To have a project with separate training and test datasets, call CreateDataset twice. On the first call, specify train for the value of DatasetType. On the second call, specify test for the value of DatasetType. This operation requires permissions to perform the lookoutvision:CreateDataset operation. */ createDataset(input: AWS.LookoutVision.CreateDatasetRequest, options: SdkCallOptions): Promise; /** * Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model. To get the current status, check the Status field returned in the response from DescribeModel. If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model. After training completes, the evaluation metrics are stored at the location specified in OutputConfig. This operation requires permissions to perform the lookoutvision:CreateModel operation. If you want to tag your model, you also require permission to the lookoutvision:TagResource operation. */ createModel(input: AWS.LookoutVision.CreateModelRequest, options: SdkCallOptions): Promise; /** * Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling CreateDataset. This operation requires permissions to perform the lookoutvision:CreateProject operation. */ createProject(input: AWS.LookoutVision.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Deletes an existing Amazon Lookout for Vision dataset. If your the project has a single dataset, you must create a new dataset before you can create a model. If you project has a training dataset and a test dataset consider the following. If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset. If you delete the training dataset, you must create a training dataset before you can create a model. This operation requires permissions to perform the lookoutvision:DeleteDataset operation. */ deleteDataset(input: AWS.LookoutVision.DeleteDatasetRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation. It might take a few seconds to delete a model. To determine if a model has been deleted, call ListModels and check if the version of the model (ModelVersion) is in the Models array. This operation requires permissions to perform the lookoutvision:DeleteModel operation. */ deleteModel(input: AWS.LookoutVision.DeleteModelRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Lookout for Vision project. To delete a project, you must first delete each version of the model associated with the project. To delete a model use the DeleteModel operation. You also have to delete the dataset(s) associated with the model. For more information, see DeleteDataset. The images referenced by the training and test datasets aren't deleted. This operation requires permissions to perform the lookoutvision:DeleteProject operation. */ deleteProject(input: AWS.LookoutVision.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Describe an Amazon Lookout for Vision dataset. This operation requires permissions to perform the lookoutvision:DescribeDataset operation. */ describeDataset(input: AWS.LookoutVision.DescribeDatasetRequest, options: SdkCallOptions): Promise; /** * Describes a version of an Amazon Lookout for Vision model. This operation requires permissions to perform the lookoutvision:DescribeModel operation. */ describeModel(input: AWS.LookoutVision.DescribeModelRequest, options: SdkCallOptions): Promise; /** * Describes an Amazon Lookout for Vision model packaging job. This operation requires permissions to perform the lookoutvision:DescribeModelPackagingJob operation. For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide. */ describeModelPackagingJob(input: AWS.LookoutVision.DescribeModelPackagingJobRequest, options: SdkCallOptions): Promise; /** * Describes an Amazon Lookout for Vision project. This operation requires permissions to perform the lookoutvision:DescribeProject operation. */ describeProject(input: AWS.LookoutVision.DescribeProjectRequest, options: SdkCallOptions): Promise; /** * Detects anomalies in an image that you supply. The response from DetectAnomalies includes a boolean prediction that the image contains one or more anomalies and a confidence value for the prediction. If the model is an image segmentation model, the response also includes segmentation information for each type of anomaly found in the image. Before calling DetectAnomalies, you must first start your model with the StartModel operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your model uses. If you are not using a model, use the StopModel operation to stop your model. For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer guide. This operation requires permissions to perform the lookoutvision:DetectAnomalies operation. */ detectAnomalies(input: AWS.LookoutVision.DetectAnomaliesRequest, options: SdkCallOptions): Promise; /** * Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label. This operation requires permissions to perform the lookoutvision:ListDatasetEntries operation. */ listDatasetEntries(input: AWS.LookoutVision.ListDatasetEntriesRequest, options: SdkCallOptions): Promise; /** * Lists the model packaging jobs created for an Amazon Lookout for Vision project. This operation requires permissions to perform the lookoutvision:ListModelPackagingJobs operation. For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide. */ listModelPackagingJobs(input: AWS.LookoutVision.ListModelPackagingJobsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a model in an Amazon Lookout for Vision project. The ListModels operation is eventually consistent. Recent calls to CreateModel might take a while to appear in the response from ListProjects. This operation requires permissions to perform the lookoutvision:ListModels operation. */ listModels(input: AWS.LookoutVision.ListModelsRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call ListProjects. The ListProjects operation is eventually consistent. Recent calls to CreateProject and DeleteProject might take a while to appear in the response from ListProjects. This operation requires permissions to perform the lookoutvision:ListProjects operation. */ listProjects(input: AWS.LookoutVision.ListProjectsRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags attached to the specified Amazon Lookout for Vision model. This operation requires permissions to perform the lookoutvision:ListTagsForResource operation. */ listTagsForResource(input: AWS.LookoutVision.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use DescribeModel. A model is ready to use when its status is HOSTED. Once the model is running, you can detect custom labels in new images by calling DetectAnomalies. You are charged for the amount of time that the model is running. To stop a running model, call StopModel. This operation requires permissions to perform the lookoutvision:StartModel operation. */ startModel(input: AWS.LookoutVision.StartModelRequest, options: SdkCallOptions): Promise; /** * Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass. Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status is SUCCEEDED. To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API. This operation requires the following permissions: lookoutvision:StartModelPackagingJob s3:PutObject s3:GetBucketLocation greengrass:CreateComponentVersion greengrass:DescribeComponent (Optional) greengrass:TagResource. Only required if you want to tag the component. For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide. */ startModelPackagingJob(input: AWS.LookoutVision.StartModelPackagingJobRequest, options: SdkCallOptions): Promise; /** * Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call DescribeModel. After the model hosting stops, the Status of the model is TRAINED. This operation requires permissions to perform the lookoutvision:StopModel operation. */ stopModel(input: AWS.LookoutVision.StopModelRequest, options: SdkCallOptions): Promise; /** * Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide. This operation requires permissions to perform the lookoutvision:TagResource operation. */ tagResource(input: AWS.LookoutVision.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide. This operation requires permissions to perform the lookoutvision:UntagResource operation. */ untagResource(input: AWS.LookoutVision.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model. To update an existing JSON Line, use the source-ref field to identify the JSON Line. The JSON line that you supply replaces the existing JSON line. Any existing annotations that are not in the new JSON line are removed from the dataset. For more information, see Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer Guide. The images you reference in the source-ref field of a JSON line, must be in the same S3 bucket as the existing images in the dataset. Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and check the Status field in the response. This operation requires permissions to perform the lookoutvision:UpdateDatasetEntries operation. */ updateDatasetEntries(input: AWS.LookoutVision.UpdateDatasetEntriesRequest, options: SdkCallOptions): Promise; } export interface M2 { /** * Cancels the running of a specific batch job execution. */ cancelBatchJobExecution(input: AWS.M2.CancelBatchJobExecutionRequest, options: SdkCallOptions): Promise; /** * Creates a new application with given parameters. Requires an existing environment and application definition file. */ createApplication(input: AWS.M2.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Starts a data set import task for a specific application. */ createDataSetImportTask(input: AWS.M2.CreateDataSetImportTaskRequest, options: SdkCallOptions): Promise; /** * Creates and starts a deployment to deploy an application into an environment. */ createDeployment(input: AWS.M2.CreateDeploymentRequest, options: SdkCallOptions): Promise; /** * Creates a runtime environment for a given runtime engine. */ createEnvironment(input: AWS.M2.CreateEnvironmentRequest, options: SdkCallOptions): Promise; /** * Deletes a specific application. You cannot delete a running application. */ deleteApplication(input: AWS.M2.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes a specific application from a specified environment where it has been previously deployed. You cannot delete an environment using DeleteEnvironment, if any application has ever been deployed to it. This API removes the association of the application with the environment so you can delete the environment smoothly. */ deleteApplicationFromEnvironment(input: AWS.M2.DeleteApplicationFromEnvironmentRequest, options: SdkCallOptions): Promise; /** * Deletes a specific environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment. */ deleteEnvironment(input: AWS.M2.DeleteEnvironmentRequest, options: SdkCallOptions): Promise; /** * Describes the details of a specific application. */ getApplication(input: AWS.M2.GetApplicationRequest, options: SdkCallOptions): Promise; /** * Returns details about a specific version of a specific application. */ getApplicationVersion(input: AWS.M2.GetApplicationVersionRequest, options: SdkCallOptions): Promise; /** * Gets the details of a specific batch job execution for a specific application. */ getBatchJobExecution(input: AWS.M2.GetBatchJobExecutionRequest, options: SdkCallOptions): Promise; /** * Gets the details of a specific data set. */ getDataSetDetails(input: AWS.M2.GetDataSetDetailsRequest, options: SdkCallOptions): Promise; /** * Gets the status of a data set import task initiated with the CreateDataSetImportTask operation. */ getDataSetImportTask(input: AWS.M2.GetDataSetImportTaskRequest, options: SdkCallOptions): Promise; /** * Gets details of a specific deployment with a given deployment identifier. */ getDeployment(input: AWS.M2.GetDeploymentRequest, options: SdkCallOptions): Promise; /** * Describes a specific runtime environment. */ getEnvironment(input: AWS.M2.GetEnvironmentRequest, options: SdkCallOptions): Promise; /** * Returns a list of the application versions for a specific application. */ listApplicationVersions(input: AWS.M2.ListApplicationVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific environment in a query parameter to see all applications associated with that environment. */ listApplications(input: AWS.M2.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. The listed batch job definitions can then be used to start a batch job. */ listBatchJobDefinitions(input: AWS.M2.ListBatchJobDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists historical, current, and scheduled batch job executions for a specific application. */ listBatchJobExecutions(input: AWS.M2.ListBatchJobExecutionsRequest, options: SdkCallOptions): Promise; /** * Lists the data set imports for the specified application. */ listDataSetImportHistory(input: AWS.M2.ListDataSetImportHistoryRequest, options: SdkCallOptions): Promise; /** * Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask. */ listDataSets(input: AWS.M2.ListDataSetsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version. */ listDeployments(input: AWS.M2.ListDeploymentsRequest, options: SdkCallOptions): Promise; /** * Lists the available engine versions. */ listEngineVersions(input: AWS.M2.ListEngineVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the runtime environments. */ listEnvironments(input: AWS.M2.ListEnvironmentsRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.M2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts an application that is currently stopped. */ startApplication(input: AWS.M2.StartApplicationRequest, options: SdkCallOptions): Promise; /** * Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job. */ startBatchJob(input: AWS.M2.StartBatchJobRequest, options: SdkCallOptions): Promise; /** * Stops a running application. */ stopApplication(input: AWS.M2.StopApplicationRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to the specified resource. */ tagResource(input: AWS.M2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. */ untagResource(input: AWS.M2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an application and creates a new version. */ updateApplication(input: AWS.M2.UpdateApplicationRequest, options: SdkCallOptions): Promise; /** * Updates the configuration details for a specific environment. */ updateEnvironment(input: AWS.M2.UpdateEnvironmentRequest, options: SdkCallOptions): Promise; } export interface MachineLearning { /** * Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value. */ addTags(input: AWS.MachineLearning.AddTagsInput, options: SdkCallOptions): Promise; /** * Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources. CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED. You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter. */ createBatchPrediction(input: AWS.MachineLearning.CreateBatchPredictionInput, options: SdkCallOptions): Promise; /** * Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations. If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. */ createDataSourceFromRDS(input: AWS.MachineLearning.CreateDataSourceFromRDSInput, options: SdkCallOptions): Promise; /** * Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation. After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions. You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values. */ createDataSourceFromRedshift(input: AWS.MachineLearning.CreateDataSourceFromRedshiftInput, options: SdkCallOptions): Promise; /** * Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations. If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource. After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions. */ createDataSourceFromS3(input: AWS.MachineLearning.CreateDataSourceFromS3Input, options: SdkCallOptions): Promise; /** * Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS. CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED. You can use the GetEvaluation operation to check progress of the evaluation during the creation operation. */ createEvaluation(input: AWS.MachineLearning.CreateEvaluationInput, options: SdkCallOptions): Promise; /** * Creates a new MLModel using the DataSource and the recipe as information sources. An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel. CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING. After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED. You can use the GetMLModel operation to check the progress of the MLModel during the creation operation. CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations. */ createMLModel(input: AWS.MachineLearning.CreateMLModelInput, options: SdkCallOptions): Promise; /** * Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel. */ createRealtimeEndpoint(input: AWS.MachineLearning.CreateRealtimeEndpointInput, options: SdkCallOptions): Promise; /** * Assigns the DELETED status to a BatchPrediction, rendering it unusable. After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED. Caution: The result of the DeleteBatchPrediction operation is irreversible. */ deleteBatchPrediction(input: AWS.MachineLearning.DeleteBatchPredictionInput, options: SdkCallOptions): Promise; /** * Assigns the DELETED status to a DataSource, rendering it unusable. After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED. Caution: The results of the DeleteDataSource operation are irreversible. */ deleteDataSource(input: AWS.MachineLearning.DeleteDataSourceInput, options: SdkCallOptions): Promise; /** * Assigns the DELETED status to an Evaluation, rendering it unusable. After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED. Caution: The results of the DeleteEvaluation operation are irreversible. */ deleteEvaluation(input: AWS.MachineLearning.DeleteEvaluationInput, options: SdkCallOptions): Promise; /** * Assigns the DELETED status to an MLModel, rendering it unusable. After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED. Caution: The result of the DeleteMLModel operation is irreversible. */ deleteMLModel(input: AWS.MachineLearning.DeleteMLModelInput, options: SdkCallOptions): Promise; /** * Deletes a real time endpoint of an MLModel. */ deleteRealtimeEndpoint(input: AWS.MachineLearning.DeleteRealtimeEndpointInput, options: SdkCallOptions): Promise; /** * Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags. If you specify a tag that doesn't exist, Amazon ML ignores it. */ deleteTags(input: AWS.MachineLearning.DeleteTagsInput, options: SdkCallOptions): Promise; /** * Returns a list of BatchPrediction operations that match the search criteria in the request. */ describeBatchPredictions(input: AWS.MachineLearning.DescribeBatchPredictionsInput, options: SdkCallOptions): Promise; /** * Returns a list of DataSource that match the search criteria in the request. */ describeDataSources(input: AWS.MachineLearning.DescribeDataSourcesInput, options: SdkCallOptions): Promise; /** * Returns a list of DescribeEvaluations that match the search criteria in the request. */ describeEvaluations(input: AWS.MachineLearning.DescribeEvaluationsInput, options: SdkCallOptions): Promise; /** * Returns a list of MLModel that match the search criteria in the request. */ describeMLModels(input: AWS.MachineLearning.DescribeMLModelsInput, options: SdkCallOptions): Promise; /** * Describes one or more of the tags for your Amazon ML object. */ describeTags(input: AWS.MachineLearning.DescribeTagsInput, options: SdkCallOptions): Promise; /** * Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request. */ getBatchPrediction(input: AWS.MachineLearning.GetBatchPredictionInput, options: SdkCallOptions): Promise; /** * Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource. GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. */ getDataSource(input: AWS.MachineLearning.GetDataSourceInput, options: SdkCallOptions): Promise; /** * Returns an Evaluation that includes metadata as well as the current status of the Evaluation. */ getEvaluation(input: AWS.MachineLearning.GetEvaluationInput, options: SdkCallOptions): Promise; /** * Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel. GetMLModel provides results in normal or verbose format. */ getMLModel(input: AWS.MachineLearning.GetMLModelInput, options: SdkCallOptions): Promise; /** * Generates a prediction for the observation using the specified ML Model. Note: Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. */ predict(input: AWS.MachineLearning.PredictInput, options: SdkCallOptions): Promise; /** * Updates the BatchPredictionName of a BatchPrediction. You can use the GetBatchPrediction operation to view the contents of the updated data element. */ updateBatchPrediction(input: AWS.MachineLearning.UpdateBatchPredictionInput, options: SdkCallOptions): Promise; /** * Updates the DataSourceName of a DataSource. You can use the GetDataSource operation to view the contents of the updated data element. */ updateDataSource(input: AWS.MachineLearning.UpdateDataSourceInput, options: SdkCallOptions): Promise; /** * Updates the EvaluationName of an Evaluation. You can use the GetEvaluation operation to view the contents of the updated data element. */ updateEvaluation(input: AWS.MachineLearning.UpdateEvaluationInput, options: SdkCallOptions): Promise; /** * Updates the MLModelName and the ScoreThreshold of an MLModel. You can use the GetMLModel operation to view the contents of the updated data element. */ updateMLModel(input: AWS.MachineLearning.UpdateMLModelInput, options: SdkCallOptions): Promise; } export interface Macie { /** * (Discontinued) Associates a specified Amazon Web Services account with Amazon Macie Classic as a member account. */ associateMemberAccount(input: AWS.Macie.AssociateMemberAccountRequest, options: SdkCallOptions): Promise<{}>; /** * (Discontinued) Associates specified S3 resources with Amazon Macie Classic for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action associates specified S3 resources with Macie Classic for the specified member account. */ associateS3Resources(input: AWS.Macie.AssociateS3ResourcesRequest, options: SdkCallOptions): Promise; /** * (Discontinued) Removes the specified member account from Amazon Macie Classic. */ disassociateMemberAccount(input: AWS.Macie.DisassociateMemberAccountRequest, options: SdkCallOptions): Promise<{}>; /** * (Discontinued) Removes specified S3 resources from being monitored by Amazon Macie Classic. If memberAccountId isn't specified, the action removes specified S3 resources from Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action removes specified S3 resources from Macie Classic for the specified member account. */ disassociateS3Resources(input: AWS.Macie.DisassociateS3ResourcesRequest, options: SdkCallOptions): Promise; /** * (Discontinued) Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account. */ listMemberAccounts(input: AWS.Macie.ListMemberAccountsRequest, options: SdkCallOptions): Promise; /** * (Discontinued) Lists all the S3 resources associated with Amazon Macie Classic. If memberAccountId isn't specified, the action lists the S3 resources associated with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action lists the S3 resources associated with Macie Classic for the specified member account. */ listS3Resources(input: AWS.Macie.ListS3ResourcesRequest, options: SdkCallOptions): Promise; /** * (Discontinued) Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Macie Classic for the specified member account. */ updateS3Resources(input: AWS.Macie.UpdateS3ResourcesRequest, options: SdkCallOptions): Promise; } export interface Macie2 { /** * Accepts an Amazon Macie membership invitation that was received from a specific account. */ acceptInvitation(input: AWS.Macie2.AcceptInvitationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about one or more custom data identifiers. */ batchGetCustomDataIdentifiers(input: AWS.Macie2.BatchGetCustomDataIdentifiersRequest, options: SdkCallOptions): Promise; /** * Creates and defines the settings for an allow list. */ createAllowList(input: AWS.Macie2.CreateAllowListRequest, options: SdkCallOptions): Promise; /** * Creates and defines the settings for a classification job. */ createClassificationJob(input: AWS.Macie2.CreateClassificationJobRequest, options: SdkCallOptions): Promise; /** * Creates and defines the criteria and other settings for a custom data identifier. */ createCustomDataIdentifier(input: AWS.Macie2.CreateCustomDataIdentifierRequest, options: SdkCallOptions): Promise; /** * Creates and defines the criteria and other settings for a findings filter. */ createFindingsFilter(input: AWS.Macie2.CreateFindingsFilterRequest, options: SdkCallOptions): Promise; /** * Sends an Amazon Macie membership invitation to one or more accounts. */ createInvitations(input: AWS.Macie2.CreateInvitationsRequest, options: SdkCallOptions): Promise; /** * Associates an account with an Amazon Macie administrator account. */ createMember(input: AWS.Macie2.CreateMemberRequest, options: SdkCallOptions): Promise; /** * Creates sample findings. */ createSampleFindings(input: AWS.Macie2.CreateSampleFindingsRequest, options: SdkCallOptions): Promise; /** * Declines Amazon Macie membership invitations that were received from specific accounts. */ declineInvitations(input: AWS.Macie2.DeclineInvitationsRequest, options: SdkCallOptions): Promise; /** * Deletes an allow list. */ deleteAllowList(input: AWS.Macie2.DeleteAllowListRequest, options: SdkCallOptions): Promise; /** * Soft deletes a custom data identifier. */ deleteCustomDataIdentifier(input: AWS.Macie2.DeleteCustomDataIdentifierRequest, options: SdkCallOptions): Promise; /** * Deletes a findings filter. */ deleteFindingsFilter(input: AWS.Macie2.DeleteFindingsFilterRequest, options: SdkCallOptions): Promise; /** * Deletes Amazon Macie membership invitations that were received from specific accounts. */ deleteInvitations(input: AWS.Macie2.DeleteInvitationsRequest, options: SdkCallOptions): Promise; /** * Deletes the association between an Amazon Macie administrator account and an account. */ deleteMember(input: AWS.Macie2.DeleteMemberRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes. */ describeBuckets(input: AWS.Macie2.DescribeBucketsRequest, options: SdkCallOptions): Promise; /** * Retrieves the status and settings for a classification job. */ describeClassificationJob(input: AWS.Macie2.DescribeClassificationJobRequest, options: SdkCallOptions): Promise; /** * Retrieves the Amazon Macie configuration settings for an organization in Organizations. */ describeOrganizationConfiguration(input: AWS.Macie2.DescribeOrganizationConfigurationRequest, options: SdkCallOptions): Promise; /** * Disables Amazon Macie and deletes all settings and resources for a Macie account. */ disableMacie(input: AWS.Macie2.DisableMacieRequest, options: SdkCallOptions): Promise; /** * Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations. */ disableOrganizationAdminAccount(input: AWS.Macie2.DisableOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates a member account from its Amazon Macie administrator account. */ disassociateFromAdministratorAccount(input: AWS.Macie2.DisassociateFromAdministratorAccountRequest, options: SdkCallOptions): Promise; /** * (Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation. */ disassociateFromMasterAccount(input: AWS.Macie2.DisassociateFromMasterAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates an Amazon Macie administrator account from a member account. */ disassociateMember(input: AWS.Macie2.DisassociateMemberRequest, options: SdkCallOptions): Promise; /** * Enables Amazon Macie and specifies the configuration settings for a Macie account. */ enableMacie(input: AWS.Macie2.EnableMacieRequest, options: SdkCallOptions): Promise; /** * Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations. */ enableOrganizationAdminAccount(input: AWS.Macie2.EnableOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the Amazon Macie administrator account for an account. */ getAdministratorAccount(input: AWS.Macie2.GetAdministratorAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves the settings and status of an allow list. */ getAllowList(input: AWS.Macie2.GetAllowListRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) aggregated statistical data about S3 buckets that Amazon Macie monitors and analyzes. */ getBucketStatistics(input: AWS.Macie2.GetBucketStatisticsRequest, options: SdkCallOptions): Promise; /** * Retrieves the configuration settings for storing data classification results. */ getClassificationExportConfiguration(input: AWS.Macie2.GetClassificationExportConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the criteria and other settings for a custom data identifier. */ getCustomDataIdentifier(input: AWS.Macie2.GetCustomDataIdentifierRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) aggregated statistical data about findings. */ getFindingStatistics(input: AWS.Macie2.GetFindingStatisticsRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of one or more findings. */ getFindings(input: AWS.Macie2.GetFindingsRequest, options: SdkCallOptions): Promise; /** * Retrieves the criteria and other settings for a findings filter. */ getFindingsFilter(input: AWS.Macie2.GetFindingsFilterRequest, options: SdkCallOptions): Promise; /** * Retrieves the configuration settings for publishing findings to Security Hub. */ getFindingsPublicationConfiguration(input: AWS.Macie2.GetFindingsPublicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the count of Amazon Macie membership invitations that were received by an account. */ getInvitationsCount(input: AWS.Macie2.GetInvitationsCountRequest, options: SdkCallOptions): Promise; /** * Retrieves the current status and configuration settings for an Amazon Macie account. */ getMacieSession(input: AWS.Macie2.GetMacieSessionRequest, options: SdkCallOptions): Promise; /** * (Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation. */ getMasterAccount(input: AWS.Macie2.GetMasterAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an account that's associated with an Amazon Macie administrator account. */ getMember(input: AWS.Macie2.GetMemberRequest, options: SdkCallOptions): Promise; /** * Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings. */ getRevealConfiguration(input: AWS.Macie2.GetRevealConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves occurrences of sensitive data reported by a finding. */ getSensitiveDataOccurrences(input: AWS.Macie2.GetSensitiveDataOccurrencesRequest, options: SdkCallOptions): Promise; /** * Checks whether occurrences of sensitive data can be retrieved for a finding. */ getSensitiveDataOccurrencesAvailability(input: AWS.Macie2.GetSensitiveDataOccurrencesAvailabilityRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) quotas and aggregated usage data for one or more accounts. */ getUsageStatistics(input: AWS.Macie2.GetUsageStatisticsRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) aggregated usage data for an account. */ getUsageTotals(input: AWS.Macie2.GetUsageTotalsRequest, options: SdkCallOptions): Promise; /** * Retrieves a subset of information about all the allow lists for an account. */ listAllowLists(input: AWS.Macie2.ListAllowListsRequest, options: SdkCallOptions): Promise; /** * Retrieves a subset of information about one or more classification jobs. */ listClassificationJobs(input: AWS.Macie2.ListClassificationJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves a subset of information about all the custom data identifiers for an account. */ listCustomDataIdentifiers(input: AWS.Macie2.ListCustomDataIdentifiersRequest, options: SdkCallOptions): Promise; /** * Retrieves a subset of information about one or more findings. */ listFindings(input: AWS.Macie2.ListFindingsRequest, options: SdkCallOptions): Promise; /** * Retrieves a subset of information about all the findings filters for an account. */ listFindingsFilters(input: AWS.Macie2.ListFindingsFiltersRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the Amazon Macie membership invitations that were received by an account. */ listInvitations(input: AWS.Macie2.ListInvitationsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about all the managed data identifiers that Amazon Macie currently provides. */ listManagedDataIdentifiers(input: AWS.Macie2.ListManagedDataIdentifiersRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the accounts that are associated with an Amazon Macie administrator account. */ listMembers(input: AWS.Macie2.ListMembersRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations. */ listOrganizationAdminAccounts(input: AWS.Macie2.ListOrganizationAdminAccountsRequest, options: SdkCallOptions): Promise; /** * Retrieves the tags (keys and values) that are associated with an Amazon Macie resource. */ listTagsForResource(input: AWS.Macie2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or updates the configuration settings for storing data classification results. */ putClassificationExportConfiguration(input: AWS.Macie2.PutClassificationExportConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the configuration settings for publishing findings to Security Hub. */ putFindingsPublicationConfiguration(input: AWS.Macie2.PutFindingsPublicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes. */ searchResources(input: AWS.Macie2.SearchResourcesRequest, options: SdkCallOptions): Promise; /** * Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource. */ tagResource(input: AWS.Macie2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Tests a custom data identifier. */ testCustomDataIdentifier(input: AWS.Macie2.TestCustomDataIdentifierRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags (keys and values) from an Amazon Macie resource. */ untagResource(input: AWS.Macie2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the settings for an allow list. */ updateAllowList(input: AWS.Macie2.UpdateAllowListRequest, options: SdkCallOptions): Promise; /** * Changes the status of a classification job. */ updateClassificationJob(input: AWS.Macie2.UpdateClassificationJobRequest, options: SdkCallOptions): Promise; /** * Updates the criteria and other settings for a findings filter. */ updateFindingsFilter(input: AWS.Macie2.UpdateFindingsFilterRequest, options: SdkCallOptions): Promise; /** * Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account. */ updateMacieSession(input: AWS.Macie2.UpdateMacieSessionRequest, options: SdkCallOptions): Promise; /** * Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account. */ updateMemberSession(input: AWS.Macie2.UpdateMemberSessionRequest, options: SdkCallOptions): Promise; /** * Updates the Amazon Macie configuration settings for an organization in Organizations. */ updateOrganizationConfiguration(input: AWS.Macie2.UpdateOrganizationConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings. */ updateRevealConfiguration(input: AWS.Macie2.UpdateRevealConfigurationRequest, options: SdkCallOptions): Promise; } export interface ManagedBlockchain { /** * Creates a member within a Managed Blockchain network. Applies only to Hyperledger Fabric. */ createMember(input: AWS.ManagedBlockchain.CreateMemberInput, options: SdkCallOptions): Promise; /** * Creates a new blockchain network using Amazon Managed Blockchain. Applies only to Hyperledger Fabric. */ createNetwork(input: AWS.ManagedBlockchain.CreateNetworkInput, options: SdkCallOptions): Promise; /** * Creates a node on the specified blockchain network. Applies to Hyperledger Fabric and Ethereum. */ createNode(input: AWS.ManagedBlockchain.CreateNodeInput, options: SdkCallOptions): Promise; /** * Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal. Applies only to Hyperledger Fabric. */ createProposal(input: AWS.ManagedBlockchain.CreateProposalInput, options: SdkCallOptions): Promise; /** * Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also. Applies only to Hyperledger Fabric. */ deleteMember(input: AWS.ManagedBlockchain.DeleteMemberInput, options: SdkCallOptions): Promise; /** * Deletes a node that your AWS account owns. All data on the node is lost and cannot be recovered. Applies to Hyperledger Fabric and Ethereum. */ deleteNode(input: AWS.ManagedBlockchain.DeleteNodeInput, options: SdkCallOptions): Promise; /** * Returns detailed information about a member. Applies only to Hyperledger Fabric. */ getMember(input: AWS.ManagedBlockchain.GetMemberInput, options: SdkCallOptions): Promise; /** * Returns detailed information about a network. Applies to Hyperledger Fabric and Ethereum. */ getNetwork(input: AWS.ManagedBlockchain.GetNetworkInput, options: SdkCallOptions): Promise; /** * Returns detailed information about a node. Applies to Hyperledger Fabric and Ethereum. */ getNode(input: AWS.ManagedBlockchain.GetNodeInput, options: SdkCallOptions): Promise; /** * Returns detailed information about a proposal. Applies only to Hyperledger Fabric. */ getProposal(input: AWS.ManagedBlockchain.GetProposalInput, options: SdkCallOptions): Promise; /** * Returns a list of all invitations for the current AWS account. Applies only to Hyperledger Fabric. */ listInvitations(input: AWS.ManagedBlockchain.ListInvitationsInput, options: SdkCallOptions): Promise; /** * Returns a list of the members in a network and properties of their configurations. Applies only to Hyperledger Fabric. */ listMembers(input: AWS.ManagedBlockchain.ListMembersInput, options: SdkCallOptions): Promise; /** * Returns information about the networks in which the current AWS account participates. Applies to Hyperledger Fabric and Ethereum. */ listNetworks(input: AWS.ManagedBlockchain.ListNetworksInput, options: SdkCallOptions): Promise; /** * Returns information about the nodes within a network. Applies to Hyperledger Fabric and Ethereum. */ listNodes(input: AWS.ManagedBlockchain.ListNodesInput, options: SdkCallOptions): Promise; /** * Returns the list of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote. Applies only to Hyperledger Fabric. */ listProposalVotes(input: AWS.ManagedBlockchain.ListProposalVotesInput, options: SdkCallOptions): Promise; /** * Returns a list of proposals for the network. Applies only to Hyperledger Fabric. */ listProposals(input: AWS.ManagedBlockchain.ListProposalsInput, options: SdkCallOptions): Promise; /** * Returns a list of tags for the specified resource. Each tag consists of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. */ listTagsForResource(input: AWS.ManagedBlockchain.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network. Applies only to Hyperledger Fabric. */ rejectInvitation(input: AWS.ManagedBlockchain.RejectInvitationInput, options: SdkCallOptions): Promise; /** * Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource. Each tag consists of a key and optional value. When you specify a tag key that already exists, the tag value is overwritten with the new value. Use UntagResource to remove tag keys. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. */ tagResource(input: AWS.ManagedBlockchain.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the Amazon Managed Blockchain resource. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. */ untagResource(input: AWS.ManagedBlockchain.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a member configuration with new parameters. Applies only to Hyperledger Fabric. */ updateMember(input: AWS.ManagedBlockchain.UpdateMemberInput, options: SdkCallOptions): Promise; /** * Updates a node configuration with new parameters. Applies only to Hyperledger Fabric. */ updateNode(input: AWS.ManagedBlockchain.UpdateNodeInput, options: SdkCallOptions): Promise; /** * Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same AWS account as the principal that calls the action. Applies only to Hyperledger Fabric. */ voteOnProposal(input: AWS.ManagedBlockchain.VoteOnProposalInput, options: SdkCallOptions): Promise; } export interface MarketplaceCatalog { /** * Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls. */ cancelChangeSet(input: AWS.MarketplaceCatalog.CancelChangeSetRequest, options: SdkCallOptions): Promise; /** * Provides information about a given change set. */ describeChangeSet(input: AWS.MarketplaceCatalog.DescribeChangeSetRequest, options: SdkCallOptions): Promise; /** * Returns the metadata and content of the entity. */ describeEntity(input: AWS.MarketplaceCatalog.DescribeEntityRequest, options: SdkCallOptions): Promise; /** * Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters. You can describe a change during the 60-day request history retention period for API calls. */ listChangeSets(input: AWS.MarketplaceCatalog.ListChangeSetsRequest, options: SdkCallOptions): Promise; /** * Provides the list of entities of a given type. */ listEntities(input: AWS.MarketplaceCatalog.ListEntitiesRequest, options: SdkCallOptions): Promise; /** * This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a ResourceInUseException. For example, you cannot start the ChangeSet described in the example later in this topic, because it contains two changes to execute the same change type (AddRevisions) against the same entity (entity-id@1). For more information about working with change sets, see Working with change sets. */ startChangeSet(input: AWS.MarketplaceCatalog.StartChangeSetRequest, options: SdkCallOptions): Promise; } export interface MarketplaceCommerceAnalytics { /** * Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy. */ generateDataSet(input: AWS.MarketplaceCommerceAnalytics.GenerateDataSetRequest, options: SdkCallOptions): Promise; /** * Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy. */ startSupportDataExport(input: AWS.MarketplaceCommerceAnalytics.StartSupportDataExportRequest, options: SdkCallOptions): Promise; } export interface MarketplaceEntitlementService { /** * GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions. */ getEntitlements(input: AWS.MarketplaceEntitlementService.GetEntitlementsRequest, options: SdkCallOptions): Promise; } export interface MarketplaceMetering { /** * BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers. For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records. Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage. Usage records are expected to be submitted as quickly as possible after the event that is being recorded, and are not accepted more than 6 hours after the event. BatchMeterUsage can process up to 25 UsageRecords at a time. A UsageRecord can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define (or allow the customer to define). BatchMeterUsage returns a list of UsageRecordResult objects, showing the result for each UsageRecord, as well as a list of UnprocessedRecords, indicating errors in the service side that you should retry. BatchMeterUsage requests must be less than 1MB in size. For an example of using BatchMeterUsage, see BatchMeterUsage code example in the AWS Marketplace Seller Guide. */ batchMeterUsage(input: AWS.MarketplaceMetering.BatchMeterUsageRequest, options: SdkCallOptions): Promise; /** * API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID. MeterUsage is authenticated on the buyer's AWS account using credentials from the EC2 instance, ECS task, or EKS pod. MeterUsage can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define (or allow the customer to define). Usage records are expected to be submitted as quickly as possible after the event that is being recorded, and are not accepted more than 6 hours after the event. */ meterUsage(input: AWS.MarketplaceMetering.MeterUsageRequest, options: SdkCallOptions): Promise; /** * Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you may choose to do so if you would like to receive usage data in your seller reports. The sections below explain the behavior of RegisterUsage. RegisterUsage performs two primary functions: metering and entitlement. Entitlement: RegisterUsage allows you to verify that the customer running your paid software is subscribed to your product on AWS Marketplace, enabling you to guard against unauthorized use. Your container image that integrates with RegisterUsage is only required to guard against unauthorized use at container startup, as such a CustomerNotSubscribedException or PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task or Amazon EKS pod is still running. Metering: RegisterUsage meters software use per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the second. A minimum of 1 minute of usage applies to tasks that are short lived. For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a service configured as a Daemon Set, then Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for software use is automatically handled by the AWS Marketplace Metering Control Plane -- your software is not required to perform any metering specific actions, other than call RegisterUsage once for metering of software use to commence. The AWS Marketplace Metering Control Plane will also continue to bill customers for running ECS tasks and Amazon EKS pods, regardless of the customers subscription state, removing the need for your software to perform entitlement checks at runtime. */ registerUsage(input: AWS.MarketplaceMetering.RegisterUsageRequest, options: SdkCallOptions): Promise; /** * ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier along with the CustomerAWSAccountId and ProductCode. The API needs to called from the seller account id used to publish the SaaS application to successfully resolve the token. For an example of using ResolveCustomer, see ResolveCustomer code example in the AWS Marketplace Seller Guide. */ resolveCustomer(input: AWS.MarketplaceMetering.ResolveCustomerRequest, options: SdkCallOptions): Promise; } export interface MediaConnect { /** * Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol. */ addFlowMediaStreams(input: AWS.MediaConnect.AddFlowMediaStreamsRequest, options: SdkCallOptions): Promise; /** * Adds outputs to an existing flow. You can create up to 50 outputs per flow. */ addFlowOutputs(input: AWS.MediaConnect.AddFlowOutputsRequest, options: SdkCallOptions): Promise; /** * Adds Sources to flow */ addFlowSources(input: AWS.MediaConnect.AddFlowSourcesRequest, options: SdkCallOptions): Promise; /** * Adds VPC interfaces to flow */ addFlowVpcInterfaces(input: AWS.MediaConnect.AddFlowVpcInterfacesRequest, options: SdkCallOptions): Promise; /** * Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50). */ createFlow(input: AWS.MediaConnect.CreateFlowRequest, options: SdkCallOptions): Promise; /** * Deletes a flow. Before you can delete a flow, you must stop the flow. */ deleteFlow(input: AWS.MediaConnect.DeleteFlowRequest, options: SdkCallOptions): Promise; /** * Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements. */ describeFlow(input: AWS.MediaConnect.DescribeFlowRequest, options: SdkCallOptions): Promise; /** * Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN). */ describeOffering(input: AWS.MediaConnect.DescribeOfferingRequest, options: SdkCallOptions): Promise; /** * Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth). */ describeReservation(input: AWS.MediaConnect.DescribeReservationRequest, options: SdkCallOptions): Promise; /** * Grants entitlements to an existing flow. */ grantFlowEntitlements(input: AWS.MediaConnect.GrantFlowEntitlementsRequest, options: SdkCallOptions): Promise; /** * Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page. */ listEntitlements(input: AWS.MediaConnect.ListEntitlementsRequest, options: SdkCallOptions): Promise; /** * Displays a list of flows that are associated with this account. This request returns a paginated result. */ listFlows(input: AWS.MediaConnect.ListFlowsRequest, options: SdkCallOptions): Promise; /** * Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings. */ listOfferings(input: AWS.MediaConnect.ListOfferingsRequest, options: SdkCallOptions): Promise; /** * Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired). */ listReservations(input: AWS.MediaConnect.ListReservationsRequest, options: SdkCallOptions): Promise; /** * List all tags on an AWS Elemental MediaConnect resource */ listTagsForResource(input: AWS.MediaConnect.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering. */ purchaseOffering(input: AWS.MediaConnect.PurchaseOfferingRequest, options: SdkCallOptions): Promise; /** * Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output. */ removeFlowMediaStream(input: AWS.MediaConnect.RemoveFlowMediaStreamRequest, options: SdkCallOptions): Promise; /** * Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output. */ removeFlowOutput(input: AWS.MediaConnect.RemoveFlowOutputRequest, options: SdkCallOptions): Promise; /** * Removes a source from an existing flow. This request can be made only if there is more than one source on the flow. */ removeFlowSource(input: AWS.MediaConnect.RemoveFlowSourceRequest, options: SdkCallOptions): Promise; /** * Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface. */ removeFlowVpcInterface(input: AWS.MediaConnect.RemoveFlowVpcInterfaceRequest, options: SdkCallOptions): Promise; /** * Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed. */ revokeFlowEntitlement(input: AWS.MediaConnect.RevokeFlowEntitlementRequest, options: SdkCallOptions): Promise; /** * Starts a flow. */ startFlow(input: AWS.MediaConnect.StartFlowRequest, options: SdkCallOptions): Promise; /** * Stops a flow. */ stopFlow(input: AWS.MediaConnect.StopFlowRequest, options: SdkCallOptions): Promise; /** * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. */ tagResource(input: AWS.MediaConnect.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes specified tags from a resource. */ untagResource(input: AWS.MediaConnect.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates flow */ updateFlow(input: AWS.MediaConnect.UpdateFlowRequest, options: SdkCallOptions): Promise; /** * You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed. */ updateFlowEntitlement(input: AWS.MediaConnect.UpdateFlowEntitlementRequest, options: SdkCallOptions): Promise; /** * Updates an existing media stream. */ updateFlowMediaStream(input: AWS.MediaConnect.UpdateFlowMediaStreamRequest, options: SdkCallOptions): Promise; /** * Updates an existing flow output. */ updateFlowOutput(input: AWS.MediaConnect.UpdateFlowOutputRequest, options: SdkCallOptions): Promise; /** * Updates the source of a flow. */ updateFlowSource(input: AWS.MediaConnect.UpdateFlowSourceRequest, options: SdkCallOptions): Promise; } export interface MediaConvert { /** * Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert. */ associateCertificate(input: AWS.MediaConvert.AssociateCertificateRequest, options: SdkCallOptions): Promise; /** * Permanently cancel a job. Once you have canceled a job, you can't start it again. */ cancelJob(input: AWS.MediaConvert.CancelJobRequest, options: SdkCallOptions): Promise; /** * Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html */ createJob(input: AWS.MediaConvert.CreateJobRequest, options: SdkCallOptions): Promise; /** * Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html */ createJobTemplate(input: AWS.MediaConvert.CreateJobTemplateRequest, options: SdkCallOptions): Promise; /** * Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html */ createPreset(input: AWS.MediaConvert.CreatePresetRequest, options: SdkCallOptions): Promise; /** * Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html */ createQueue(input: AWS.MediaConvert.CreateQueueRequest, options: SdkCallOptions): Promise; /** * Permanently delete a job template you have created. */ deleteJobTemplate(input: AWS.MediaConvert.DeleteJobTemplateRequest, options: SdkCallOptions): Promise; /** * Permanently delete a policy that you created. */ deletePolicy(input: AWS.MediaConvert.DeletePolicyRequest, options: SdkCallOptions): Promise; /** * Permanently delete a preset you have created. */ deletePreset(input: AWS.MediaConvert.DeletePresetRequest, options: SdkCallOptions): Promise; /** * Permanently delete a queue you have created. */ deleteQueue(input: AWS.MediaConvert.DeleteQueueRequest, options: SdkCallOptions): Promise; /** * Send an request with an empty body to the regional API endpoint to get your account API endpoint. */ describeEndpoints(input: AWS.MediaConvert.DescribeEndpointsRequest, options: SdkCallOptions): Promise; /** * Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource. */ disassociateCertificate(input: AWS.MediaConvert.DisassociateCertificateRequest, options: SdkCallOptions): Promise; /** * Retrieve the JSON for a specific completed transcoding job. */ getJob(input: AWS.MediaConvert.GetJobRequest, options: SdkCallOptions): Promise; /** * Retrieve the JSON for a specific job template. */ getJobTemplate(input: AWS.MediaConvert.GetJobTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieve the JSON for your policy. */ getPolicy(input: AWS.MediaConvert.GetPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieve the JSON for a specific preset. */ getPreset(input: AWS.MediaConvert.GetPresetRequest, options: SdkCallOptions): Promise; /** * Retrieve the JSON for a specific queue. */ getQueue(input: AWS.MediaConvert.GetQueueRequest, options: SdkCallOptions): Promise; /** * Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array */ listJobTemplates(input: AWS.MediaConvert.ListJobTemplatesRequest, options: SdkCallOptions): Promise; /** * Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array. */ listJobs(input: AWS.MediaConvert.ListJobsRequest, options: SdkCallOptions): Promise; /** * Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array. */ listPresets(input: AWS.MediaConvert.ListPresetsRequest, options: SdkCallOptions): Promise; /** * Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array. */ listQueues(input: AWS.MediaConvert.ListQueuesRequest, options: SdkCallOptions): Promise; /** * Retrieve the tags for a MediaConvert resource. */ listTagsForResource(input: AWS.MediaConvert.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Create or change your policy. For more information about policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html */ putPolicy(input: AWS.MediaConvert.PutPolicyRequest, options: SdkCallOptions): Promise; /** * Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html */ tagResource(input: AWS.MediaConvert.TagResourceRequest, options: SdkCallOptions): Promise; /** * Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html */ untagResource(input: AWS.MediaConvert.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Modify one of your existing job templates. */ updateJobTemplate(input: AWS.MediaConvert.UpdateJobTemplateRequest, options: SdkCallOptions): Promise; /** * Modify one of your existing presets. */ updatePreset(input: AWS.MediaConvert.UpdatePresetRequest, options: SdkCallOptions): Promise; /** * Modify one of your existing queues. */ updateQueue(input: AWS.MediaConvert.UpdateQueueRequest, options: SdkCallOptions): Promise; } export interface MediaLive { /** * Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account. */ acceptInputDeviceTransfer(input: AWS.MediaLive.AcceptInputDeviceTransferRequest, options: SdkCallOptions): Promise; /** * Starts delete of resources. */ batchDelete(input: AWS.MediaLive.BatchDeleteRequest, options: SdkCallOptions): Promise; /** * Starts existing resources */ batchStart(input: AWS.MediaLive.BatchStartRequest, options: SdkCallOptions): Promise; /** * Stops running resources */ batchStop(input: AWS.MediaLive.BatchStopRequest, options: SdkCallOptions): Promise; /** * Update a channel schedule */ batchUpdateSchedule(input: AWS.MediaLive.BatchUpdateScheduleRequest, options: SdkCallOptions): Promise; /** * Cancel an input device transfer that you have requested. */ cancelInputDeviceTransfer(input: AWS.MediaLive.CancelInputDeviceTransferRequest, options: SdkCallOptions): Promise; /** * Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor. After the request succeeds, you will own the device. */ claimDevice(input: AWS.MediaLive.ClaimDeviceRequest, options: SdkCallOptions): Promise; /** * Creates a new channel */ createChannel(input: AWS.MediaLive.CreateChannelRequest, options: SdkCallOptions): Promise; /** * Create an input */ createInput(input: AWS.MediaLive.CreateInputRequest, options: SdkCallOptions): Promise; /** * Creates a Input Security Group */ createInputSecurityGroup(input: AWS.MediaLive.CreateInputSecurityGroupRequest, options: SdkCallOptions): Promise; /** * Create a new multiplex. */ createMultiplex(input: AWS.MediaLive.CreateMultiplexRequest, options: SdkCallOptions): Promise; /** * Create a new program in the multiplex. */ createMultiplexProgram(input: AWS.MediaLive.CreateMultiplexProgramRequest, options: SdkCallOptions): Promise; /** * Create a partner input */ createPartnerInput(input: AWS.MediaLive.CreatePartnerInputRequest, options: SdkCallOptions): Promise; /** * Create tags for a resource */ createTags(input: AWS.MediaLive.CreateTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Starts deletion of channel. The associated outputs are also deleted. */ deleteChannel(input: AWS.MediaLive.DeleteChannelRequest, options: SdkCallOptions): Promise; /** * Deletes the input end point */ deleteInput(input: AWS.MediaLive.DeleteInputRequest, options: SdkCallOptions): Promise; /** * Deletes an Input Security Group */ deleteInputSecurityGroup(input: AWS.MediaLive.DeleteInputSecurityGroupRequest, options: SdkCallOptions): Promise; /** * Delete a multiplex. The multiplex must be idle. */ deleteMultiplex(input: AWS.MediaLive.DeleteMultiplexRequest, options: SdkCallOptions): Promise; /** * Delete a program from a multiplex. */ deleteMultiplexProgram(input: AWS.MediaLive.DeleteMultiplexProgramRequest, options: SdkCallOptions): Promise; /** * Delete an expired reservation. */ deleteReservation(input: AWS.MediaLive.DeleteReservationRequest, options: SdkCallOptions): Promise; /** * Delete all schedule actions on a channel. */ deleteSchedule(input: AWS.MediaLive.DeleteScheduleRequest, options: SdkCallOptions): Promise; /** * Removes tags for a resource */ deleteTags(input: AWS.MediaLive.DeleteTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Gets details about a channel */ describeChannel(input: AWS.MediaLive.DescribeChannelRequest, options: SdkCallOptions): Promise; /** * Produces details about an input */ describeInput(input: AWS.MediaLive.DescribeInputRequest, options: SdkCallOptions): Promise; /** * Gets the details for the input device */ describeInputDevice(input: AWS.MediaLive.DescribeInputDeviceRequest, options: SdkCallOptions): Promise; /** * Get the latest thumbnail data for the input device. */ describeInputDeviceThumbnail(input: AWS.MediaLive.DescribeInputDeviceThumbnailRequest, options: SdkCallOptions): Promise; /** * Produces a summary of an Input Security Group */ describeInputSecurityGroup(input: AWS.MediaLive.DescribeInputSecurityGroupRequest, options: SdkCallOptions): Promise; /** * Gets details about a multiplex. */ describeMultiplex(input: AWS.MediaLive.DescribeMultiplexRequest, options: SdkCallOptions): Promise; /** * Get the details for a program in a multiplex. */ describeMultiplexProgram(input: AWS.MediaLive.DescribeMultiplexProgramRequest, options: SdkCallOptions): Promise; /** * Get details for an offering. */ describeOffering(input: AWS.MediaLive.DescribeOfferingRequest, options: SdkCallOptions): Promise; /** * Get details for a reservation. */ describeReservation(input: AWS.MediaLive.DescribeReservationRequest, options: SdkCallOptions): Promise; /** * Get a channel schedule */ describeSchedule(input: AWS.MediaLive.DescribeScheduleRequest, options: SdkCallOptions): Promise; /** * Produces list of channels that have been created */ listChannels(input: AWS.MediaLive.ListChannelsRequest, options: SdkCallOptions): Promise; /** * List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you. */ listInputDeviceTransfers(input: AWS.MediaLive.ListInputDeviceTransfersRequest, options: SdkCallOptions): Promise; /** * List input devices */ listInputDevices(input: AWS.MediaLive.ListInputDevicesRequest, options: SdkCallOptions): Promise; /** * Produces a list of Input Security Groups for an account */ listInputSecurityGroups(input: AWS.MediaLive.ListInputSecurityGroupsRequest, options: SdkCallOptions): Promise; /** * Produces list of inputs that have been created */ listInputs(input: AWS.MediaLive.ListInputsRequest, options: SdkCallOptions): Promise; /** * List the programs that currently exist for a specific multiplex. */ listMultiplexPrograms(input: AWS.MediaLive.ListMultiplexProgramsRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of the existing multiplexes. */ listMultiplexes(input: AWS.MediaLive.ListMultiplexesRequest, options: SdkCallOptions): Promise; /** * List offerings available for purchase. */ listOfferings(input: AWS.MediaLive.ListOfferingsRequest, options: SdkCallOptions): Promise; /** * List purchased reservations. */ listReservations(input: AWS.MediaLive.ListReservationsRequest, options: SdkCallOptions): Promise; /** * Produces list of tags that have been created for a resource */ listTagsForResource(input: AWS.MediaLive.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Purchase an offering and create a reservation. */ purchaseOffering(input: AWS.MediaLive.PurchaseOfferingRequest, options: SdkCallOptions): Promise; /** * Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected. */ rebootInputDevice(input: AWS.MediaLive.RebootInputDeviceRequest, options: SdkCallOptions): Promise; /** * Reject the transfer of the specified input device to your AWS account. */ rejectInputDeviceTransfer(input: AWS.MediaLive.RejectInputDeviceTransferRequest, options: SdkCallOptions): Promise; /** * Starts an existing channel */ startChannel(input: AWS.MediaLive.StartChannelRequest, options: SdkCallOptions): Promise; /** * Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance. */ startInputDeviceMaintenanceWindow(input: AWS.MediaLive.StartInputDeviceMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel. */ startMultiplex(input: AWS.MediaLive.StartMultiplexRequest, options: SdkCallOptions): Promise; /** * Stops a running channel */ stopChannel(input: AWS.MediaLive.StopChannelRequest, options: SdkCallOptions): Promise; /** * Stops a running multiplex. If the multiplex isn't running, this action has no effect. */ stopMultiplex(input: AWS.MediaLive.StopMultiplexRequest, options: SdkCallOptions): Promise; /** * Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer. */ transferInputDevice(input: AWS.MediaLive.TransferInputDeviceRequest, options: SdkCallOptions): Promise; /** * Updates a channel. */ updateChannel(input: AWS.MediaLive.UpdateChannelRequest, options: SdkCallOptions): Promise; /** * Changes the class of the channel. */ updateChannelClass(input: AWS.MediaLive.UpdateChannelClassRequest, options: SdkCallOptions): Promise; /** * Updates an input. */ updateInput(input: AWS.MediaLive.UpdateInputRequest, options: SdkCallOptions): Promise; /** * Updates the parameters for the input device. */ updateInputDevice(input: AWS.MediaLive.UpdateInputDeviceRequest, options: SdkCallOptions): Promise; /** * Update an Input Security Group's Whilelists. */ updateInputSecurityGroup(input: AWS.MediaLive.UpdateInputSecurityGroupRequest, options: SdkCallOptions): Promise; /** * Updates a multiplex. */ updateMultiplex(input: AWS.MediaLive.UpdateMultiplexRequest, options: SdkCallOptions): Promise; /** * Update a program in a multiplex. */ updateMultiplexProgram(input: AWS.MediaLive.UpdateMultiplexProgramRequest, options: SdkCallOptions): Promise; /** * Update reservation. */ updateReservation(input: AWS.MediaLive.UpdateReservationRequest, options: SdkCallOptions): Promise; } export interface MediaPackage { /** * Changes the Channel's properities to configure log subscription */ configureLogs(input: AWS.MediaPackage.ConfigureLogsRequest, options: SdkCallOptions): Promise; /** * Creates a new Channel. */ createChannel(input: AWS.MediaPackage.CreateChannelRequest, options: SdkCallOptions): Promise; /** * Creates a new HarvestJob record. */ createHarvestJob(input: AWS.MediaPackage.CreateHarvestJobRequest, options: SdkCallOptions): Promise; /** * Creates a new OriginEndpoint record. */ createOriginEndpoint(input: AWS.MediaPackage.CreateOriginEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes an existing Channel. */ deleteChannel(input: AWS.MediaPackage.DeleteChannelRequest, options: SdkCallOptions): Promise; /** * Deletes an existing OriginEndpoint. */ deleteOriginEndpoint(input: AWS.MediaPackage.DeleteOriginEndpointRequest, options: SdkCallOptions): Promise; /** * Gets details about a Channel. */ describeChannel(input: AWS.MediaPackage.DescribeChannelRequest, options: SdkCallOptions): Promise; /** * Gets details about an existing HarvestJob. */ describeHarvestJob(input: AWS.MediaPackage.DescribeHarvestJobRequest, options: SdkCallOptions): Promise; /** * Gets details about an existing OriginEndpoint. */ describeOriginEndpoint(input: AWS.MediaPackage.DescribeOriginEndpointRequest, options: SdkCallOptions): Promise; /** * Returns a collection of Channels. */ listChannels(input: AWS.MediaPackage.ListChannelsRequest, options: SdkCallOptions): Promise; /** * Returns a collection of HarvestJob records. */ listHarvestJobs(input: AWS.MediaPackage.ListHarvestJobsRequest, options: SdkCallOptions): Promise; /** * Returns a collection of OriginEndpoint records. */ listOriginEndpoints(input: AWS.MediaPackage.ListOriginEndpointsRequest, options: SdkCallOptions): Promise; listTagsForResource(input: AWS.MediaPackage.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead */ rotateChannelCredentials(input: AWS.MediaPackage.RotateChannelCredentialsRequest, options: SdkCallOptions): Promise; /** * Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id. */ rotateIngestEndpointCredentials(input: AWS.MediaPackage.RotateIngestEndpointCredentialsRequest, options: SdkCallOptions): Promise; tagResource(input: AWS.MediaPackage.TagResourceRequest, options: SdkCallOptions): Promise<{}>; untagResource(input: AWS.MediaPackage.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an existing Channel. */ updateChannel(input: AWS.MediaPackage.UpdateChannelRequest, options: SdkCallOptions): Promise; /** * Updates an existing OriginEndpoint. */ updateOriginEndpoint(input: AWS.MediaPackage.UpdateOriginEndpointRequest, options: SdkCallOptions): Promise; } export interface MediaPackageVod { /** * Changes the packaging group's properities to configure log subscription */ configureLogs(input: AWS.MediaPackageVod.ConfigureLogsRequest, options: SdkCallOptions): Promise; /** * Creates a new MediaPackage VOD Asset resource. */ createAsset(input: AWS.MediaPackageVod.CreateAssetRequest, options: SdkCallOptions): Promise; /** * Creates a new MediaPackage VOD PackagingConfiguration resource. */ createPackagingConfiguration(input: AWS.MediaPackageVod.CreatePackagingConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a new MediaPackage VOD PackagingGroup resource. */ createPackagingGroup(input: AWS.MediaPackageVod.CreatePackagingGroupRequest, options: SdkCallOptions): Promise; /** * Deletes an existing MediaPackage VOD Asset resource. */ deleteAsset(input: AWS.MediaPackageVod.DeleteAssetRequest, options: SdkCallOptions): Promise; /** * Deletes a MediaPackage VOD PackagingConfiguration resource. */ deletePackagingConfiguration(input: AWS.MediaPackageVod.DeletePackagingConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a MediaPackage VOD PackagingGroup resource. */ deletePackagingGroup(input: AWS.MediaPackageVod.DeletePackagingGroupRequest, options: SdkCallOptions): Promise; /** * Returns a description of a MediaPackage VOD Asset resource. */ describeAsset(input: AWS.MediaPackageVod.DescribeAssetRequest, options: SdkCallOptions): Promise; /** * Returns a description of a MediaPackage VOD PackagingConfiguration resource. */ describePackagingConfiguration(input: AWS.MediaPackageVod.DescribePackagingConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns a description of a MediaPackage VOD PackagingGroup resource. */ describePackagingGroup(input: AWS.MediaPackageVod.DescribePackagingGroupRequest, options: SdkCallOptions): Promise; /** * Returns a collection of MediaPackage VOD Asset resources. */ listAssets(input: AWS.MediaPackageVod.ListAssetsRequest, options: SdkCallOptions): Promise; /** * Returns a collection of MediaPackage VOD PackagingConfiguration resources. */ listPackagingConfigurations(input: AWS.MediaPackageVod.ListPackagingConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns a collection of MediaPackage VOD PackagingGroup resources. */ listPackagingGroups(input: AWS.MediaPackageVod.ListPackagingGroupsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags assigned to the specified resource. */ listTagsForResource(input: AWS.MediaPackageVod.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds tags to the specified resource. You can specify one or more tags to add. */ tagResource(input: AWS.MediaPackageVod.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes tags from the specified resource. You can specify one or more tags to remove. */ untagResource(input: AWS.MediaPackageVod.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a specific packaging group. You can't change the id attribute or any other system-generated attributes. */ updatePackagingGroup(input: AWS.MediaPackageVod.UpdatePackagingGroupRequest, options: SdkCallOptions): Promise; } export interface MediaStore { /** * Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service. */ createContainer(input: AWS.MediaStore.CreateContainerInput, options: SdkCallOptions): Promise; /** * Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers. */ deleteContainer(input: AWS.MediaStore.DeleteContainerInput, options: SdkCallOptions): Promise; /** * Deletes the access policy that is associated with the specified container. */ deleteContainerPolicy(input: AWS.MediaStore.DeleteContainerPolicyInput, options: SdkCallOptions): Promise; /** * Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others. */ deleteCorsPolicy(input: AWS.MediaStore.DeleteCorsPolicyInput, options: SdkCallOptions): Promise; /** * Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect. */ deleteLifecyclePolicy(input: AWS.MediaStore.DeleteLifecyclePolicyInput, options: SdkCallOptions): Promise; /** * Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch. */ deleteMetricPolicy(input: AWS.MediaStore.DeleteMetricPolicyInput, options: SdkCallOptions): Promise; /** * Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers. */ describeContainer(input: AWS.MediaStore.DescribeContainerInput, options: SdkCallOptions): Promise; /** * Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. */ getContainerPolicy(input: AWS.MediaStore.GetContainerPolicyInput, options: SdkCallOptions): Promise; /** * Returns the cross-origin resource sharing (CORS) configuration information that is set for the container. To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others. */ getCorsPolicy(input: AWS.MediaStore.GetCorsPolicyInput, options: SdkCallOptions): Promise; /** * Retrieves the object lifecycle policy that is assigned to a container. */ getLifecyclePolicy(input: AWS.MediaStore.GetLifecyclePolicyInput, options: SdkCallOptions): Promise; /** * Returns the metric policy for the specified container. */ getMetricPolicy(input: AWS.MediaStore.GetMetricPolicyInput, options: SdkCallOptions): Promise; /** * Lists the properties of all containers in AWS Elemental MediaStore. You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive. See also DescribeContainer, which gets the properties of one container. */ listContainers(input: AWS.MediaStore.ListContainersInput, options: SdkCallOptions): Promise; /** * Returns a list of the tags assigned to the specified container. */ listTagsForResource(input: AWS.MediaStore.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide. For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy. */ putContainerPolicy(input: AWS.MediaStore.PutContainerPolicyInput, options: SdkCallOptions): Promise; /** * Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability. To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed. To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore. */ putCorsPolicy(input: AWS.MediaStore.PutCorsPolicyInput, options: SdkCallOptions): Promise; /** * Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect. For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy. */ putLifecyclePolicy(input: AWS.MediaStore.PutLifecyclePolicyInput, options: SdkCallOptions): Promise; /** * The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect. */ putMetricPolicy(input: AWS.MediaStore.PutMetricPolicyInput, options: SdkCallOptions): Promise; /** * Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs. */ startAccessLogging(input: AWS.MediaStore.StartAccessLoggingInput, options: SdkCallOptions): Promise; /** * Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable. */ stopAccessLogging(input: AWS.MediaStore.StopAccessLoggingInput, options: SdkCallOptions): Promise; /** * Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore. */ tagResource(input: AWS.MediaStore.TagResourceInput, options: SdkCallOptions): Promise; /** * Removes tags from the specified container. You can specify one or more tags to remove. */ untagResource(input: AWS.MediaStore.UntagResourceInput, options: SdkCallOptions): Promise; } export interface MediaStoreData { /** * Deletes an object at the specified path. */ deleteObject(input: AWS.MediaStoreData.DeleteObjectRequest, options: SdkCallOptions): Promise; /** * Gets the headers for an object at the specified path. */ describeObject(input: AWS.MediaStoreData.DescribeObjectRequest, options: SdkCallOptions): Promise; /** * Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object. */ getObject(input: AWS.MediaStoreData.GetObjectRequest, options: SdkCallOptions): Promise; /** * Provides a list of metadata entries about folders and objects in the specified folder. */ listItems(input: AWS.MediaStoreData.ListItemsRequest, options: SdkCallOptions): Promise; /** * Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability. */ putObject(input: AWS.MediaStoreData.PutObjectRequest, options: SdkCallOptions): Promise; } export interface MediaTailor { /** * Configures Amazon CloudWatch log settings for a playback configuration. */ configureLogsForPlaybackConfiguration(input: AWS.MediaTailor.ConfigureLogsForPlaybackConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a channel. */ createChannel(input: AWS.MediaTailor.CreateChannelRequest, options: SdkCallOptions): Promise; /** * Creates name for a specific live source in a source location. */ createLiveSource(input: AWS.MediaTailor.CreateLiveSourceRequest, options: SdkCallOptions): Promise; /** * Creates a new prefetch schedule for the specified playback configuration. */ createPrefetchSchedule(input: AWS.MediaTailor.CreatePrefetchScheduleRequest, options: SdkCallOptions): Promise; /** * Creates a program. */ createProgram(input: AWS.MediaTailor.CreateProgramRequest, options: SdkCallOptions): Promise; /** * Creates a source location on a specific channel. */ createSourceLocation(input: AWS.MediaTailor.CreateSourceLocationRequest, options: SdkCallOptions): Promise; /** * Creates name for a specific VOD source in a source location. */ createVodSource(input: AWS.MediaTailor.CreateVodSourceRequest, options: SdkCallOptions): Promise; /** * Deletes a channel. You must stop the channel before it can be deleted. */ deleteChannel(input: AWS.MediaTailor.DeleteChannelRequest, options: SdkCallOptions): Promise; /** * Deletes a channel's IAM policy. */ deleteChannelPolicy(input: AWS.MediaTailor.DeleteChannelPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a specific live source in a specific source location. */ deleteLiveSource(input: AWS.MediaTailor.DeleteLiveSourceRequest, options: SdkCallOptions): Promise; /** * Deletes the playback configuration for the specified name. */ deletePlaybackConfiguration(input: AWS.MediaTailor.DeletePlaybackConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. */ deletePrefetchSchedule(input: AWS.MediaTailor.DeletePrefetchScheduleRequest, options: SdkCallOptions): Promise; /** * Deletes a specific program on a specific channel. */ deleteProgram(input: AWS.MediaTailor.DeleteProgramRequest, options: SdkCallOptions): Promise; /** * Deletes a source location on a specific channel. */ deleteSourceLocation(input: AWS.MediaTailor.DeleteSourceLocationRequest, options: SdkCallOptions): Promise; /** * Deletes a specific VOD source in a specific source location. */ deleteVodSource(input: AWS.MediaTailor.DeleteVodSourceRequest, options: SdkCallOptions): Promise; /** * Describes the properties of a specific channel. */ describeChannel(input: AWS.MediaTailor.DescribeChannelRequest, options: SdkCallOptions): Promise; /** * Provides details about a specific live source in a specific source location. */ describeLiveSource(input: AWS.MediaTailor.DescribeLiveSourceRequest, options: SdkCallOptions): Promise; /** * Retrieves the properties of the requested program. */ describeProgram(input: AWS.MediaTailor.DescribeProgramRequest, options: SdkCallOptions): Promise; /** * Retrieves the properties of the requested source location. */ describeSourceLocation(input: AWS.MediaTailor.DescribeSourceLocationRequest, options: SdkCallOptions): Promise; /** * Provides details about a specific VOD source in a specific source location. */ describeVodSource(input: AWS.MediaTailor.DescribeVodSourceRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a channel's IAM policy. */ getChannelPolicy(input: AWS.MediaTailor.GetChannelPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves information about your channel's schedule. */ getChannelSchedule(input: AWS.MediaTailor.GetChannelScheduleRequest, options: SdkCallOptions): Promise; /** * Returns the playback configuration for the specified name. */ getPlaybackConfiguration(input: AWS.MediaTailor.GetPlaybackConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. */ getPrefetchSchedule(input: AWS.MediaTailor.GetPrefetchScheduleRequest, options: SdkCallOptions): Promise; /** * Returns a list of alerts for the given resource. */ listAlerts(input: AWS.MediaTailor.ListAlertsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of channels that are associated with this account. */ listChannels(input: AWS.MediaTailor.ListChannelsRequest, options: SdkCallOptions): Promise; /** * lists all the live sources in a source location. */ listLiveSources(input: AWS.MediaTailor.ListLiveSourcesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful. */ listPlaybackConfigurations(input: AWS.MediaTailor.ListPlaybackConfigurationsRequest, options: SdkCallOptions): Promise; /** * Creates a new prefetch schedule. */ listPrefetchSchedules(input: AWS.MediaTailor.ListPrefetchSchedulesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of source locations. */ listSourceLocations(input: AWS.MediaTailor.ListSourceLocationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags assigned to the specified playback configuration resource. */ listTagsForResource(input: AWS.MediaTailor.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists all the VOD sources in a source location. */ listVodSources(input: AWS.MediaTailor.ListVodSourcesRequest, options: SdkCallOptions): Promise; /** * Creates an IAM policy for the channel. */ putChannelPolicy(input: AWS.MediaTailor.PutChannelPolicyRequest, options: SdkCallOptions): Promise; /** * Adds a new playback configuration to AWS Elemental MediaTailor. */ putPlaybackConfiguration(input: AWS.MediaTailor.PutPlaybackConfigurationRequest, options: SdkCallOptions): Promise; /** * Starts a specific channel. */ startChannel(input: AWS.MediaTailor.StartChannelRequest, options: SdkCallOptions): Promise; /** * Stops a specific channel. */ stopChannel(input: AWS.MediaTailor.StopChannelRequest, options: SdkCallOptions): Promise; /** * Adds tags to the specified playback configuration resource. You can specify one or more tags to add. */ tagResource(input: AWS.MediaTailor.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes tags from the specified playback configuration resource. You can specify one or more tags to remove. */ untagResource(input: AWS.MediaTailor.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an existing channel. */ updateChannel(input: AWS.MediaTailor.UpdateChannelRequest, options: SdkCallOptions): Promise; /** * Updates a specific live source in a specific source location. */ updateLiveSource(input: AWS.MediaTailor.UpdateLiveSourceRequest, options: SdkCallOptions): Promise; /** * Updates a source location on a specific channel. */ updateSourceLocation(input: AWS.MediaTailor.UpdateSourceLocationRequest, options: SdkCallOptions): Promise; /** * Updates a specific VOD source in a specific source location. */ updateVodSource(input: AWS.MediaTailor.UpdateVodSourceRequest, options: SdkCallOptions): Promise; } export interface MemoryDB { /** * Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates. */ batchUpdateCluster(input: AWS.MemoryDB.BatchUpdateClusterRequest, options: SdkCallOptions): Promise; /** * Makes a copy of an existing snapshot. */ copySnapshot(input: AWS.MemoryDB.CopySnapshotRequest, options: SdkCallOptions): Promise; /** * Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs). */ createACL(input: AWS.MemoryDB.CreateACLRequest, options: SdkCallOptions): Promise; /** * Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software. */ createCluster(input: AWS.MemoryDB.CreateClusterRequest, options: SdkCallOptions): Promise; /** * Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups. */ createParameterGroup(input: AWS.MemoryDB.CreateParameterGroupRequest, options: SdkCallOptions): Promise; /** * Creates a copy of an entire cluster at a specific moment in time. */ createSnapshot(input: AWS.MemoryDB.CreateSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups. */ createSubnetGroup(input: AWS.MemoryDB.CreateSubnetGroupRequest, options: SdkCallOptions): Promise; /** * Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs). */ createUser(input: AWS.MemoryDB.CreateUserRequest, options: SdkCallOptions): Promise; /** * Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs). */ deleteACL(input: AWS.MemoryDB.DeleteACLRequest, options: SdkCallOptions): Promise; /** * Deletes a cluster. It also deletes all associated nodes and node endpoints */ deleteCluster(input: AWS.MemoryDB.DeleteClusterRequest, options: SdkCallOptions): Promise; /** * Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account. */ deleteParameterGroup(input: AWS.MemoryDB.DeleteParameterGroupRequest, options: SdkCallOptions): Promise; /** * Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation. */ deleteSnapshot(input: AWS.MemoryDB.DeleteSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters. */ deleteSubnetGroup(input: AWS.MemoryDB.DeleteSubnetGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters. */ deleteUser(input: AWS.MemoryDB.DeleteUserRequest, options: SdkCallOptions): Promise; /** * Returns a list of ACLs */ describeACLs(input: AWS.MemoryDB.DescribeACLsRequest, options: SdkCallOptions): Promise; /** * Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied. */ describeClusters(input: AWS.MemoryDB.DescribeClustersRequest, options: SdkCallOptions): Promise; /** * Returns a list of the available Redis engine versions. */ describeEngineVersions(input: AWS.MemoryDB.DescribeEngineVersionsRequest, options: SdkCallOptions): Promise; /** * Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. */ describeEvents(input: AWS.MemoryDB.DescribeEventsRequest, options: SdkCallOptions): Promise; /** * Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group. */ describeParameterGroups(input: AWS.MemoryDB.DescribeParameterGroupsRequest, options: SdkCallOptions): Promise; /** * Returns the detailed parameter list for a particular parameter group. */ describeParameters(input: AWS.MemoryDB.DescribeParametersRequest, options: SdkCallOptions): Promise; /** * Returns details of the service updates */ describeServiceUpdates(input: AWS.MemoryDB.DescribeServiceUpdatesRequest, options: SdkCallOptions): Promise; /** * Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster. */ describeSnapshots(input: AWS.MemoryDB.DescribeSnapshotsRequest, options: SdkCallOptions): Promise; /** * Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. */ describeSubnetGroups(input: AWS.MemoryDB.DescribeSubnetGroupsRequest, options: SdkCallOptions): Promise; /** * Returns a list of users. */ describeUsers(input: AWS.MemoryDB.DescribeUsersRequest, options: SdkCallOptions): Promise; /** * Used to failover a shard */ failoverShard(input: AWS.MemoryDB.FailoverShardRequest, options: SdkCallOptions): Promise; /** * Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation. */ listAllowedNodeTypeUpdates(input: AWS.MemoryDB.ListAllowedNodeTypeUpdatesRequest, options: SdkCallOptions): Promise; /** * Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources */ listTags(input: AWS.MemoryDB.ListTagsRequest, options: SdkCallOptions): Promise; /** * Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters. */ resetParameterGroup(input: AWS.MemoryDB.ResetParameterGroupRequest, options: SdkCallOptions): Promise; /** * A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions. For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags. */ tagResource(input: AWS.MemoryDB.TagResourceRequest, options: SdkCallOptions): Promise; /** * Use this operation to remove tags on a resource */ untagResource(input: AWS.MemoryDB.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Changes the list of users that belong to the Access Control List. */ updateACL(input: AWS.MemoryDB.UpdateACLRequest, options: SdkCallOptions): Promise; /** * Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values. */ updateCluster(input: AWS.MemoryDB.UpdateClusterRequest, options: SdkCallOptions): Promise; /** * Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. */ updateParameterGroup(input: AWS.MemoryDB.UpdateParameterGroupRequest, options: SdkCallOptions): Promise; /** * Updates a subnet group. For more information, see Updating a subnet group */ updateSubnetGroup(input: AWS.MemoryDB.UpdateSubnetGroupRequest, options: SdkCallOptions): Promise; /** * Changes user password(s) and/or access string. */ updateUser(input: AWS.MemoryDB.UpdateUserRequest, options: SdkCallOptions): Promise; } export interface Mgn { /** * Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.) */ changeServerLifeCycleState(input: AWS.Mgn.ChangeServerLifeCycleStateRequest, options: SdkCallOptions): Promise; /** * Creates a new ReplicationConfigurationTemplate. */ createLaunchConfigurationTemplate(input: AWS.Mgn.CreateLaunchConfigurationTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a new ReplicationConfigurationTemplate. */ createReplicationConfigurationTemplate(input: AWS.Mgn.CreateReplicationConfigurationTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a single Job by ID. */ deleteJob(input: AWS.Mgn.DeleteJobRequest, options: SdkCallOptions): Promise; /** * Creates a new ReplicationConfigurationTemplate. */ deleteLaunchConfigurationTemplate(input: AWS.Mgn.DeleteLaunchConfigurationTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a single Replication Configuration Template by ID */ deleteReplicationConfigurationTemplate(input: AWS.Mgn.DeleteReplicationConfigurationTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a single source server by ID. */ deleteSourceServer(input: AWS.Mgn.DeleteSourceServerRequest, options: SdkCallOptions): Promise; /** * Deletes a given vCenter client by ID. */ deleteVcenterClient(input: AWS.Mgn.DeleteVcenterClientRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves detailed job log items with paging. */ describeJobLogItems(input: AWS.Mgn.DescribeJobLogItemsRequest, options: SdkCallOptions): Promise; /** * Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets. */ describeJobs(input: AWS.Mgn.DescribeJobsRequest, options: SdkCallOptions): Promise; /** * Creates a new ReplicationConfigurationTemplate. */ describeLaunchConfigurationTemplates(input: AWS.Mgn.DescribeLaunchConfigurationTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs. */ describeReplicationConfigurationTemplates(input: AWS.Mgn.DescribeReplicationConfigurationTemplatesRequest, options: SdkCallOptions): Promise; /** * Retrieves all SourceServers or multiple SourceServers by ID. */ describeSourceServers(input: AWS.Mgn.DescribeSourceServersRequest, options: SdkCallOptions): Promise; /** * Returns a list of the installed vCenter clients. */ describeVcenterClients(input: AWS.Mgn.DescribeVcenterClientsRequest, options: SdkCallOptions): Promise; /** * Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified. */ disconnectFromService(input: AWS.Mgn.DisconnectFromServiceRequest, options: SdkCallOptions): Promise; /** * Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified. */ finalizeCutover(input: AWS.Mgn.FinalizeCutoverRequest, options: SdkCallOptions): Promise; /** * Lists all LaunchConfigurations available, filtered by Source Server IDs. */ getLaunchConfiguration(input: AWS.Mgn.GetLaunchConfigurationRequest, options: SdkCallOptions): Promise; /** * Lists all ReplicationConfigurations, filtered by Source Server ID. */ getReplicationConfiguration(input: AWS.Mgn.GetReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Initialize Application Migration Service. */ initializeService(input: AWS.Mgn.InitializeServiceRequest, options: SdkCallOptions): Promise; /** * List all tags for your Application Migration Service resources. */ listTagsForResource(input: AWS.Mgn.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER. */ markAsArchived(input: AWS.Mgn.MarkAsArchivedRequest, options: SdkCallOptions): Promise; /** * Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state. */ retryDataReplication(input: AWS.Mgn.RetryDataReplicationRequest, options: SdkCallOptions): Promise; /** * Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER. */ startCutover(input: AWS.Mgn.StartCutoverRequest, options: SdkCallOptions): Promise; /** * Starts replication for SNAPSHOT_SHIPPING agents. */ startReplication(input: AWS.Mgn.StartReplicationRequest, options: SdkCallOptions): Promise; /** * Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING. */ startTest(input: AWS.Mgn.StartTestRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. */ tagResource(input: AWS.Mgn.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER. */ terminateTargetInstances(input: AWS.Mgn.TerminateTargetInstancesRequest, options: SdkCallOptions): Promise; /** * Deletes the specified set of tags from the specified set of Application Migration Service resources. */ untagResource(input: AWS.Mgn.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates multiple LaunchConfigurations by Source Server ID. */ updateLaunchConfiguration(input: AWS.Mgn.UpdateLaunchConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a new ReplicationConfigurationTemplate. */ updateLaunchConfigurationTemplate(input: AWS.Mgn.UpdateLaunchConfigurationTemplateRequest, options: SdkCallOptions): Promise; /** * Allows you to update multiple ReplicationConfigurations by Source Server ID. */ updateReplicationConfiguration(input: AWS.Mgn.UpdateReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates multiple ReplicationConfigurationTemplates by ID. */ updateReplicationConfigurationTemplate(input: AWS.Mgn.UpdateReplicationConfigurationTemplateRequest, options: SdkCallOptions): Promise; /** * Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type. */ updateSourceServerReplicationType(input: AWS.Mgn.UpdateSourceServerReplicationTypeRequest, options: SdkCallOptions): Promise; } export interface MigrationHub { /** * Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits: Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task. The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc. */ associateCreatedArtifact(input: AWS.MigrationHub.AssociateCreatedArtifactRequest, options: SdkCallOptions): Promise; /** * Associates a discovered resource ID from Application Discovery Service with a migration task. */ associateDiscoveredResource(input: AWS.MigrationHub.AssociateDiscoveredResourceRequest, options: SdkCallOptions): Promise; /** * Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account. */ createProgressUpdateStream(input: AWS.MigrationHub.CreateProgressUpdateStreamRequest, options: SdkCallOptions): Promise; /** * Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits: The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call). The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts). If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call. CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted. Once the stream and all of its resources are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream). */ deleteProgressUpdateStream(input: AWS.MigrationHub.DeleteProgressUpdateStreamRequest, options: SdkCallOptions): Promise; /** * Gets the migration status of an application. */ describeApplicationState(input: AWS.MigrationHub.DescribeApplicationStateRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all attributes associated with a specific migration task. */ describeMigrationTask(input: AWS.MigrationHub.DescribeMigrationTaskRequest, options: SdkCallOptions): Promise; /** * Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits: A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task. The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc. */ disassociateCreatedArtifact(input: AWS.MigrationHub.DisassociateCreatedArtifactRequest, options: SdkCallOptions): Promise; /** * Disassociate an Application Discovery Service discovered resource from a migration task. */ disassociateDiscoveredResource(input: AWS.MigrationHub.DisassociateDiscoveredResourceRequest, options: SdkCallOptions): Promise; /** * Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool. This API is a prerequisite to calling the NotifyMigrationTaskState API as the migration tool must first register the migration task with Migration Hub. */ importMigrationTask(input: AWS.MigrationHub.ImportMigrationTaskRequest, options: SdkCallOptions): Promise; /** * Lists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned. */ listApplicationStates(input: AWS.MigrationHub.ListApplicationStatesRequest, options: SdkCallOptions): Promise; /** * Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits: Gets the list of the created artifacts while migration is taking place. Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API. Lists created artifacts in a paginated interface. */ listCreatedArtifacts(input: AWS.MigrationHub.ListCreatedArtifactsRequest, options: SdkCallOptions): Promise; /** * Lists discovered resources associated with the given MigrationTask. */ listDiscoveredResources(input: AWS.MigrationHub.ListDiscoveredResourcesRequest, options: SdkCallOptions): Promise; /** * Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits: Can show a summary list of the most recent migration tasks. Can show a summary list of migration tasks associated with a given discovered resource. Lists migration tasks in a paginated interface. */ listMigrationTasks(input: AWS.MigrationHub.ListMigrationTasksRequest, options: SdkCallOptions): Promise; /** * Lists progress update streams associated with the user account making this call. */ listProgressUpdateStreams(input: AWS.MigrationHub.ListProgressUpdateStreamsRequest, options: SdkCallOptions): Promise; /** * Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED. */ notifyApplicationState(input: AWS.MigrationHub.NotifyApplicationStateRequest, options: SdkCallOptions): Promise; /** * Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits: Migration tools will call the NotifyMigrationTaskState API to share the latest progress and status. MigrationTaskName is used for addressing updates to the correct target. ProgressUpdateStream is used for access control and to provide a namespace for each migration tool. */ notifyMigrationTaskState(input: AWS.MigrationHub.NotifyMigrationTaskStateRequest, options: SdkCallOptions): Promise; /** * Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository. This association occurs asynchronously after PutResourceAttributes returns. Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overriding the MAC address. Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any "VM" related value. Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources. */ putResourceAttributes(input: AWS.MigrationHub.PutResourceAttributesRequest, options: SdkCallOptions): Promise; } export interface MigrationHubConfig { /** * This API sets up the home region for the calling account only. */ createHomeRegionControl(input: AWS.MigrationHubConfig.CreateHomeRegionControlRequest, options: SdkCallOptions): Promise; /** * This API permits filtering on the ControlId and HomeRegion fields. */ describeHomeRegionControls(input: AWS.MigrationHubConfig.DescribeHomeRegionControlsRequest, options: SdkCallOptions): Promise; /** * Returns the calling account’s home region, if configured. This API is used by other AWS services to determine the regional endpoint for calling AWS Application Discovery Service and Migration Hub. You must call GetHomeRegion at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region. */ getHomeRegion(input: AWS.MigrationHubConfig.GetHomeRegionRequest, options: SdkCallOptions): Promise; } export interface MigrationHubOrchestrator { /** * Create a workflow to orchestrate your migrations. */ createWorkflow(input: AWS.MigrationHubOrchestrator.CreateMigrationWorkflowRequest, options: SdkCallOptions): Promise; /** * Create a step in the migration workflow. */ createWorkflowStep(input: AWS.MigrationHubOrchestrator.CreateWorkflowStepRequest, options: SdkCallOptions): Promise; /** * Create a step group in a migration workflow. */ createWorkflowStepGroup(input: AWS.MigrationHubOrchestrator.CreateWorkflowStepGroupRequest, options: SdkCallOptions): Promise; /** * Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it. */ deleteWorkflow(input: AWS.MigrationHubOrchestrator.DeleteMigrationWorkflowRequest, options: SdkCallOptions): Promise; /** * Delete a step in a migration workflow. Pause the workflow to delete a running step. */ deleteWorkflowStep(input: AWS.MigrationHubOrchestrator.DeleteWorkflowStepRequest, options: SdkCallOptions): Promise; /** * Delete a step group in a migration workflow. */ deleteWorkflowStepGroup(input: AWS.MigrationHubOrchestrator.DeleteWorkflowStepGroupRequest, options: SdkCallOptions): Promise; /** * Get the template you want to use for creating a migration workflow. */ getTemplate(input: AWS.MigrationHubOrchestrator.GetMigrationWorkflowTemplateRequest, options: SdkCallOptions): Promise; /** * Get a specific step in a template. */ getTemplateStep(input: AWS.MigrationHubOrchestrator.GetTemplateStepRequest, options: SdkCallOptions): Promise; /** * Get a step group in a template. */ getTemplateStepGroup(input: AWS.MigrationHubOrchestrator.GetTemplateStepGroupRequest, options: SdkCallOptions): Promise; /** * Get migration workflow. */ getWorkflow(input: AWS.MigrationHubOrchestrator.GetMigrationWorkflowRequest, options: SdkCallOptions): Promise; /** * Get a step in the migration workflow. */ getWorkflowStep(input: AWS.MigrationHubOrchestrator.GetWorkflowStepRequest, options: SdkCallOptions): Promise; /** * Get the step group of a migration workflow. */ getWorkflowStepGroup(input: AWS.MigrationHubOrchestrator.GetWorkflowStepGroupRequest, options: SdkCallOptions): Promise; /** * List AWS Migration Hub Orchestrator plugins. */ listPlugins(input: AWS.MigrationHubOrchestrator.ListPluginsRequest, options: SdkCallOptions): Promise; /** * List the tags added to a resource. */ listTagsForResource(input: AWS.MigrationHubOrchestrator.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * List the step groups in a template. */ listTemplateStepGroups(input: AWS.MigrationHubOrchestrator.ListTemplateStepGroupsRequest, options: SdkCallOptions): Promise; /** * List the steps in a template. */ listTemplateSteps(input: AWS.MigrationHubOrchestrator.ListTemplateStepsRequest, options: SdkCallOptions): Promise; /** * List the templates available in Migration Hub Orchestrator to create a migration workflow. */ listTemplates(input: AWS.MigrationHubOrchestrator.ListMigrationWorkflowTemplatesRequest, options: SdkCallOptions): Promise; /** * List the step groups in a migration workflow. */ listWorkflowStepGroups(input: AWS.MigrationHubOrchestrator.ListWorkflowStepGroupsRequest, options: SdkCallOptions): Promise; /** * List the steps in a workflow. */ listWorkflowSteps(input: AWS.MigrationHubOrchestrator.ListWorkflowStepsRequest, options: SdkCallOptions): Promise; /** * List the migration workflows. */ listWorkflows(input: AWS.MigrationHubOrchestrator.ListMigrationWorkflowsRequest, options: SdkCallOptions): Promise; /** * Retry a failed step in a migration workflow. */ retryWorkflowStep(input: AWS.MigrationHubOrchestrator.RetryWorkflowStepRequest, options: SdkCallOptions): Promise; /** * Start a migration workflow. */ startWorkflow(input: AWS.MigrationHubOrchestrator.StartMigrationWorkflowRequest, options: SdkCallOptions): Promise; /** * Stop an ongoing migration workflow. */ stopWorkflow(input: AWS.MigrationHubOrchestrator.StopMigrationWorkflowRequest, options: SdkCallOptions): Promise; /** * Tag a resource by specifying its Amazon Resource Name (ARN). */ tagResource(input: AWS.MigrationHubOrchestrator.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes the tags for a resource. */ untagResource(input: AWS.MigrationHubOrchestrator.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update a migration workflow. */ updateWorkflow(input: AWS.MigrationHubOrchestrator.UpdateMigrationWorkflowRequest, options: SdkCallOptions): Promise; /** * Update a step in a migration workflow. */ updateWorkflowStep(input: AWS.MigrationHubOrchestrator.UpdateWorkflowStepRequest, options: SdkCallOptions): Promise; /** * Update the step group in a migration workflow. */ updateWorkflowStepGroup(input: AWS.MigrationHubOrchestrator.UpdateWorkflowStepGroupRequest, options: SdkCallOptions): Promise; } export interface MigrationHubRefactorSpaces { /** * Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and Network Load Balancer for the application proxy inside your account. */ createApplication(input: AWS.MigrationHubRefactorSpaces.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the environment owner. The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account. */ createEnvironment(input: AWS.MigrationHubRefactorSpaces.CreateEnvironmentRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType. When created, the default route defaults to an active state so state is not a required input. However, like all other state values the state of the default route can be updated after creation, but only when all other routes are also inactive. Conversely, no route can be active without the default route also being active. When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows: If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link. If the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet. If the service has an Lambda function endpoint, then Refactor Spaces configures the Lambda function's resource policy to allow the application's API Gateway to invoke the function. A one-time health check is performed on the service when either the route is updated from inactive to active, or when it is created with an active state. If the health check fails, the route transitions the route state to FAILED, an error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent to the service. For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is Failed, then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide. For Lambda endpoints, a check is performed to determine that a Lambda function with the specified ARN exists. If it does not exist, the health check fails. For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails. For private URLS, a target group is created on the Elastic Load Balancing and the target group health check is run. The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state. Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain is also publicly resolvable. */ createRoute(input: AWS.MigrationHubRefactorSpaces.CreateRouteRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint. If an Amazon Web Services resource is launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more cross-account constraints, apply your own security group. */ createService(input: AWS.MigrationHubRefactorSpaces.CreateServiceRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first delete any services or routes within the application. */ deleteApplication(input: AWS.MigrationHubRefactorSpaces.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment. */ deleteEnvironment(input: AWS.MigrationHubRefactorSpaces.DeleteEnvironmentRequest, options: SdkCallOptions): Promise; /** * Deletes the resource policy set for the environment. */ deleteResourcePolicy(input: AWS.MigrationHubRefactorSpaces.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Web Services Migration Hub Refactor Spaces route. */ deleteRoute(input: AWS.MigrationHubRefactorSpaces.DeleteRouteRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Web Services Migration Hub Refactor Spaces service. */ deleteService(input: AWS.MigrationHubRefactorSpaces.DeleteServiceRequest, options: SdkCallOptions): Promise; /** * Gets an Amazon Web Services Migration Hub Refactor Spaces application. */ getApplication(input: AWS.MigrationHubRefactorSpaces.GetApplicationRequest, options: SdkCallOptions): Promise; /** * Gets an Amazon Web Services Migration Hub Refactor Spaces environment. */ getEnvironment(input: AWS.MigrationHubRefactorSpaces.GetEnvironmentRequest, options: SdkCallOptions): Promise; /** * Gets the resource-based permission policy that is set for the given environment. */ getResourcePolicy(input: AWS.MigrationHubRefactorSpaces.GetResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Gets an Amazon Web Services Migration Hub Refactor Spaces route. */ getRoute(input: AWS.MigrationHubRefactorSpaces.GetRouteRequest, options: SdkCallOptions): Promise; /** * Gets an Amazon Web Services Migration Hub Refactor Spaces service. */ getService(input: AWS.MigrationHubRefactorSpaces.GetServiceRequest, options: SdkCallOptions): Promise; /** * Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment. */ listApplications(input: AWS.MigrationHubRefactorSpaces.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment. */ listEnvironmentVpcs(input: AWS.MigrationHubRefactorSpaces.ListEnvironmentVpcsRequest, options: SdkCallOptions): Promise; /** * Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account. */ listEnvironments(input: AWS.MigrationHubRefactorSpaces.ListEnvironmentsRequest, options: SdkCallOptions): Promise; /** * Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application. */ listRoutes(input: AWS.MigrationHubRefactorSpaces.ListRoutesRequest, options: SdkCallOptions): Promise; /** * Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application. */ listServices(input: AWS.MigrationHubRefactorSpaces.ListServicesRequest, options: SdkCallOptions): Promise; /** * Lists the tags of a resource. The caller account must be the same as the resource’s OwnerAccountId. Listing tags in other accounts is not supported. */ listTagsForResource(input: AWS.MigrationHubRefactorSpaces.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy must contain the same actions and condition statements as the arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in Resource Access Manager. The policy must not contain new lines or blank lines. */ putResourcePolicy(input: AWS.MigrationHubRefactorSpaces.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Removes the tags of a given resource. Tags are metadata which can be used to manage a resource. To tag a resource, the caller account must be the same as the resource’s OwnerAccountId. Tagging resources in other accounts is not supported. Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway. */ tagResource(input: AWS.MigrationHubRefactorSpaces.TagResourceRequest, options: SdkCallOptions): Promise; /** * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. To untag a resource, the caller account must be the same as the resource’s OwnerAccountId. Untagging resources across accounts is not supported. */ untagResource(input: AWS.MigrationHubRefactorSpaces.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon Web Services Migration Hub Refactor Spaces route. */ updateRoute(input: AWS.MigrationHubRefactorSpaces.UpdateRouteRequest, options: SdkCallOptions): Promise; } export interface MigrationHubStrategy { /** * Retrieves details about an application component. */ getApplicationComponentDetails(input: AWS.MigrationHubStrategy.GetApplicationComponentDetailsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all the recommended strategies and tools for an application component running on a server. */ getApplicationComponentStrategies(input: AWS.MigrationHubStrategy.GetApplicationComponentStrategiesRequest, options: SdkCallOptions): Promise; /** * Retrieves the status of an on-going assessment. */ getAssessment(input: AWS.MigrationHubStrategy.GetAssessmentRequest, options: SdkCallOptions): Promise; /** * Retrieves the details about a specific import task. */ getImportFileTask(input: AWS.MigrationHubStrategy.GetImportFileTaskRequest, options: SdkCallOptions): Promise; /** * Retrieves your migration and modernization preferences. */ getPortfolioPreferences(input: AWS.MigrationHubStrategy.GetPortfolioPreferencesRequest, options: SdkCallOptions): Promise; /** * Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns. */ getPortfolioSummary(input: AWS.MigrationHubStrategy.GetPortfolioSummaryRequest, options: SdkCallOptions): Promise; /** * Retrieves detailed information about the specified recommendation report. */ getRecommendationReportDetails(input: AWS.MigrationHubStrategy.GetRecommendationReportDetailsRequest, options: SdkCallOptions): Promise; /** * Retrieves detailed information about a specified server. */ getServerDetails(input: AWS.MigrationHubStrategy.GetServerDetailsRequest, options: SdkCallOptions): Promise; /** * Retrieves recommended strategies and tools for the specified server. */ getServerStrategies(input: AWS.MigrationHubStrategy.GetServerStrategiesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all the application components (processes). */ listApplicationComponents(input: AWS.MigrationHubStrategy.ListApplicationComponentsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all the installed collectors. */ listCollectors(input: AWS.MigrationHubStrategy.ListCollectorsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all the imports performed. */ listImportFileTask(input: AWS.MigrationHubStrategy.ListImportFileTaskRequest, options: SdkCallOptions): Promise; /** * Returns a list of all the servers. */ listServers(input: AWS.MigrationHubStrategy.ListServersRequest, options: SdkCallOptions): Promise; /** * Saves the specified migration and modernization preferences. */ putPortfolioPreferences(input: AWS.MigrationHubStrategy.PutPortfolioPreferencesRequest, options: SdkCallOptions): Promise; /** * Starts the assessment of an on-premises environment. */ startAssessment(input: AWS.MigrationHubStrategy.StartAssessmentRequest, options: SdkCallOptions): Promise; /** * Starts a file import. */ startImportFileTask(input: AWS.MigrationHubStrategy.StartImportFileTaskRequest, options: SdkCallOptions): Promise; /** * Starts generating a recommendation report. */ startRecommendationReportGeneration(input: AWS.MigrationHubStrategy.StartRecommendationReportGenerationRequest, options: SdkCallOptions): Promise; /** * Stops the assessment of an on-premises environment. */ stopAssessment(input: AWS.MigrationHubStrategy.StopAssessmentRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an application component. */ updateApplicationComponentConfig(input: AWS.MigrationHubStrategy.UpdateApplicationComponentConfigRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of the specified server. */ updateServerConfig(input: AWS.MigrationHubStrategy.UpdateServerConfigRequest, options: SdkCallOptions): Promise; } export interface Mobile { /** * Creates an AWS Mobile Hub project. */ createProject(input: AWS.Mobile.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Delets a project in AWS Mobile Hub. */ deleteProject(input: AWS.Mobile.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Get the bundle details for the requested bundle id. */ describeBundle(input: AWS.Mobile.DescribeBundleRequest, options: SdkCallOptions): Promise; /** * Gets details about a project in AWS Mobile Hub. */ describeProject(input: AWS.Mobile.DescribeProjectRequest, options: SdkCallOptions): Promise; /** * Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources. */ exportBundle(input: AWS.Mobile.ExportBundleRequest, options: SdkCallOptions): Promise; /** * Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account. */ exportProject(input: AWS.Mobile.ExportProjectRequest, options: SdkCallOptions): Promise; /** * List all available bundles. */ listBundles(input: AWS.Mobile.ListBundlesRequest, options: SdkCallOptions): Promise; /** * Lists projects in AWS Mobile Hub. */ listProjects(input: AWS.Mobile.ListProjectsRequest, options: SdkCallOptions): Promise; /** * Update an existing project. */ updateProject(input: AWS.Mobile.UpdateProjectRequest, options: SdkCallOptions): Promise; } export interface MobileAnalytics { /** * The PutEvents operation records one or more events. You can have up to 1,500 unique custom events per app, any combination of up to 40 attributes and metrics per custom event, and any number of attribute or metric values. */ putEvents(input: AWS.MobileAnalytics.PutEventsInput, options: SdkCallOptions): Promise<{}>; } export interface MQ { /** * Creates a broker. Note: This API is asynchronous. To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy. ec2:CreateNetworkInterface This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account. ec2:CreateNetworkInterfacePermission This permission is required to attach the ENI to the broker instance. ec2:DeleteNetworkInterface ec2:DeleteNetworkInterfacePermission ec2:DetachNetworkInterface ec2:DescribeInternetGateways ec2:DescribeNetworkInterfaces ec2:DescribeNetworkInterfacePermissions ec2:DescribeRouteTables ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcs For more information, see Create an IAM User and Get Your AWS Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide. */ createBroker(input: AWS.MQ.CreateBrokerRequest, options: SdkCallOptions): Promise; /** * Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). */ createConfiguration(input: AWS.MQ.CreateConfigurationRequest, options: SdkCallOptions): Promise; /** * Add a tag to a resource. */ createTags(input: AWS.MQ.CreateTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Creates an ActiveMQ user. */ createUser(input: AWS.MQ.CreateUserRequest, options: SdkCallOptions): Promise; /** * Deletes a broker. Note: This API is asynchronous. */ deleteBroker(input: AWS.MQ.DeleteBrokerRequest, options: SdkCallOptions): Promise; /** * Removes a tag from a resource. */ deleteTags(input: AWS.MQ.DeleteTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an ActiveMQ user. */ deleteUser(input: AWS.MQ.DeleteUserRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified broker. */ describeBroker(input: AWS.MQ.DescribeBrokerRequest, options: SdkCallOptions): Promise; /** * Describe available engine types and versions. */ describeBrokerEngineTypes(input: AWS.MQ.DescribeBrokerEngineTypesRequest, options: SdkCallOptions): Promise; /** * Describe available broker instance options. */ describeBrokerInstanceOptions(input: AWS.MQ.DescribeBrokerInstanceOptionsRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified configuration. */ describeConfiguration(input: AWS.MQ.DescribeConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns the specified configuration revision for the specified configuration. */ describeConfigurationRevision(input: AWS.MQ.DescribeConfigurationRevisionRequest, options: SdkCallOptions): Promise; /** * Returns information about an ActiveMQ user. */ describeUser(input: AWS.MQ.DescribeUserRequest, options: SdkCallOptions): Promise; /** * Returns a list of all brokers. */ listBrokers(input: AWS.MQ.ListBrokersRequest, options: SdkCallOptions): Promise; /** * Returns a list of all revisions for the specified configuration. */ listConfigurationRevisions(input: AWS.MQ.ListConfigurationRevisionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all configurations. */ listConfigurations(input: AWS.MQ.ListConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists tags for a resource. */ listTags(input: AWS.MQ.ListTagsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all ActiveMQ users. */ listUsers(input: AWS.MQ.ListUsersRequest, options: SdkCallOptions): Promise; /** * Reboots a broker. Note: This API is asynchronous. */ rebootBroker(input: AWS.MQ.RebootBrokerRequest, options: SdkCallOptions): Promise; /** * Adds a pending configuration change to a broker. */ updateBroker(input: AWS.MQ.UpdateBrokerRequest, options: SdkCallOptions): Promise; /** * Updates the specified configuration. */ updateConfiguration(input: AWS.MQ.UpdateConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the information for an ActiveMQ user. */ updateUser(input: AWS.MQ.UpdateUserRequest, options: SdkCallOptions): Promise; } export interface MTurk { /** * The AcceptQualificationRequest operation approves a Worker's request for a Qualification. Only the owner of the Qualification type can grant a Qualification request for that type. A successful request for the AcceptQualificationRequest operation returns with no errors and an empty body. */ acceptQualificationRequest(input: AWS.MTurk.AcceptQualificationRequestRequest, options: SdkCallOptions): Promise; /** * The ApproveAssignment operation approves the results of a completed assignment. Approving an assignment initiates two payments from the Requester's Amazon.com account The Worker who submitted the results is paid the reward specified in the HIT. Amazon Mechanical Turk fees are debited. If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site. You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted. */ approveAssignment(input: AWS.MTurk.ApproveAssignmentRequest, options: SdkCallOptions): Promise; /** * The AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker. You can only assign a Qualification of a Qualification type that you created (using the CreateQualificationType operation). Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending Qualification request without affecting the Qualification the Worker already has, reject the request with the RejectQualificationRequest operation. */ associateQualificationWithWorker(input: AWS.MTurk.AssociateQualificationWithWorkerRequest, options: SdkCallOptions): Promise; /** * The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT. To extend the maximum number of assignments, specify the number of additional assignments. HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception. HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception. */ createAdditionalAssignmentsForHIT(input: AWS.MTurk.CreateAdditionalAssignmentsForHITRequest, options: SdkCallOptions): Promise; /** * The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical Turk website. This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT is created for you, with a new HITTypeID. The HITTypeID can be used to create additional HITs in the future without needing to specify common parameters such as the title, description and reward amount each time. An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType operation and then call the CreateHITWithHITType operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. CreateHIT also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters. If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing. */ createHIT(input: AWS.MTurk.CreateHITRequest, options: SdkCallOptions): Promise; /** * The CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned. */ createHITType(input: AWS.MTurk.CreateHITTypeRequest, options: SdkCallOptions): Promise; /** * The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation. This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. CreateHITWithHITType also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters. If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing. */ createHITWithHITType(input: AWS.MTurk.CreateHITWithHITTypeRequest, options: SdkCallOptions): Promise; /** * The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure. */ createQualificationType(input: AWS.MTurk.CreateQualificationTypeRequest, options: SdkCallOptions): Promise; /** * The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers. */ createWorkerBlock(input: AWS.MTurk.CreateWorkerBlockRequest, options: SdkCallOptions): Promise; /** * The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it. You can only dispose of HITs that are in the Reviewable state, with all of their submitted assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in the Reviewable state (for example, that has not expired, or still has active assignments), or on a HIT that is Reviewable but without all of its submitted assignments already approved or rejected, the service will return an error. HITs are automatically disposed of after 120 days. After you dispose of a HIT, you can no longer approve the HIT's rejected assignments. Disposed HITs are not returned in results for the ListHITs operation. Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs. */ deleteHIT(input: AWS.MTurk.DeleteHITRequest, options: SdkCallOptions): Promise; /** * The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types. DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType. */ deleteQualificationType(input: AWS.MTurk.DeleteQualificationTypeRequest, options: SdkCallOptions): Promise; /** * The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully. */ deleteWorkerBlock(input: AWS.MTurk.DeleteWorkerBlockRequest, options: SdkCallOptions): Promise; /** * The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user. You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message. */ disassociateQualificationFromWorker(input: AWS.MTurk.DisassociateQualificationFromWorkerRequest, options: SdkCallOptions): Promise; /** * The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester. Alternatively, this operation will retrieve the remaining available AWS Billing usage if you have enabled AWS Billing. Note: If you have enabled AWS Billing and still have a remaining Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console. */ getAccountBalance(input: AWS.MTurk.GetAccountBalanceRequest, options: SdkCallOptions): Promise; /** * The GetAssignment operation retrieves the details of the specified Assignment. */ getAssignment(input: AWS.MTurk.GetAssignmentRequest, options: SdkCallOptions): Promise; /** * The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure will no longer support the FileUploadAnswer element to be used for the QuestionForm data structure. Instead, we recommend that Requesters who want to create HITs asking Workers to upload files to use Amazon S3. */ getFileUploadURL(input: AWS.MTurk.GetFileUploadURLRequest, options: SdkCallOptions): Promise; /** * The GetHIT operation retrieves the details of the specified HIT. */ getHIT(input: AWS.MTurk.GetHITRequest, options: SdkCallOptions): Promise; /** * The GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type. To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment data returned by the ListAssignmentsForHIT operation. Only the owner of a Qualification type can query the value of a Worker's Qualification of that type. */ getQualificationScore(input: AWS.MTurk.GetQualificationScoreRequest, options: SdkCallOptions): Promise; /** * The GetQualificationTypeoperation retrieves information about a Qualification type using its ID. */ getQualificationType(input: AWS.MTurk.GetQualificationTypeRequest, options: SdkCallOptions): Promise; /** * The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT. You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation. Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set. Only the Requester who created the HIT can retrieve the assignments for that HIT. Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination. */ listAssignmentsForHIT(input: AWS.MTurk.ListAssignmentsForHITRequest, options: SdkCallOptions): Promise; /** * The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment. */ listBonusPayments(input: AWS.MTurk.ListBonusPaymentsRequest, options: SdkCallOptions): Promise; /** * The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted. */ listHITs(input: AWS.MTurk.ListHITsRequest, options: SdkCallOptions): Promise; /** * The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted with the DeleteHIT operation or that have been auto-deleted. */ listHITsForQualificationType(input: AWS.MTurk.ListHITsForQualificationTypeRequest, options: SdkCallOptions): Promise; /** * The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation. */ listQualificationRequests(input: AWS.MTurk.ListQualificationRequestsRequest, options: SdkCallOptions): Promise; /** * The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term. */ listQualificationTypes(input: AWS.MTurk.ListQualificationTypesRequest, options: SdkCallOptions): Promise; /** * The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results. */ listReviewPolicyResultsForHIT(input: AWS.MTurk.ListReviewPolicyResultsForHITRequest, options: SdkCallOptions): Promise; /** * The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation. */ listReviewableHITs(input: AWS.MTurk.ListReviewableHITsRequest, options: SdkCallOptions): Promise; /** * The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs. */ listWorkerBlocks(input: AWS.MTurk.ListWorkerBlocksRequest, options: SdkCallOptions): Promise; /** * The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type. */ listWorkersWithQualificationType(input: AWS.MTurk.ListWorkersWithQualificationTypeRequest, options: SdkCallOptions): Promise; /** * The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker. */ notifyWorkers(input: AWS.MTurk.NotifyWorkersRequest, options: SdkCallOptions): Promise; /** * The RejectAssignment operation rejects the results of a completed assignment. You can include an optional feedback message with the rejection, which the Worker can see in the Status section of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the assignment was rejected, and can improve the quality of the results the Worker submits in the future. Only the Requester who created the HIT can reject an assignment for the HIT. */ rejectAssignment(input: AWS.MTurk.RejectAssignmentRequest, options: SdkCallOptions): Promise; /** * The RejectQualificationRequest operation rejects a user's request for a Qualification. You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message. */ rejectQualificationRequest(input: AWS.MTurk.RejectQualificationRequestRequest, options: SdkCallOptions): Promise; /** * The SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees. */ sendBonus(input: AWS.MTurk.SendBonusRequest, options: SdkCallOptions): Promise; /** * The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them using the website. When you call this operation, the service attempts to send the test notification immediately. */ sendTestEventNotification(input: AWS.MTurk.SendTestEventNotificationRequest, options: SdkCallOptions): Promise; /** * The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately expired. */ updateExpirationForHIT(input: AWS.MTurk.UpdateExpirationForHITRequest, options: SdkCallOptions): Promise; /** * The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status. */ updateHITReviewStatus(input: AWS.MTurk.UpdateHITReviewStatusRequest, options: SdkCallOptions): Promise; /** * The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones. */ updateHITTypeOfHIT(input: AWS.MTurk.UpdateHITTypeOfHITRequest, options: SdkCallOptions): Promise; /** * The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one. You can call the UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself by providing updates to the Active status without specifying a new notification specification. To change the Active status of a HIT type's notifications, the HIT type must already have a notification specification, or one must be provided in the same call to UpdateNotificationSettings. */ updateNotificationSettings(input: AWS.MTurk.UpdateNotificationSettingsRequest, options: SdkCallOptions): Promise; /** * The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes. Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries. You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key. If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test. If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values. If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually. You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type. */ updateQualificationType(input: AWS.MTurk.UpdateQualificationTypeRequest, options: SdkCallOptions): Promise; } export interface MWAA { /** * Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token. */ createCliToken(input: AWS.MWAA.CreateCliTokenRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment. */ createEnvironment(input: AWS.MWAA.CreateEnvironmentInput, options: SdkCallOptions): Promise; /** * Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token. */ createWebLoginToken(input: AWS.MWAA.CreateWebLoginTokenRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment. */ deleteEnvironment(input: AWS.MWAA.DeleteEnvironmentInput, options: SdkCallOptions): Promise; /** * Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment. */ getEnvironment(input: AWS.MWAA.GetEnvironmentInput, options: SdkCallOptions): Promise; /** * Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments. */ listEnvironments(input: AWS.MWAA.ListEnvironmentsInput, options: SdkCallOptions): Promise; /** * Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging". */ listTagsForResource(input: AWS.MWAA.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Internal only. Publishes environment health metrics to Amazon CloudWatch. */ publishMetrics(input: AWS.MWAA.PublishMetricsInput, options: SdkCallOptions): Promise; /** * Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. */ tagResource(input: AWS.MWAA.TagResourceInput, options: SdkCallOptions): Promise; /** * Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging". */ untagResource(input: AWS.MWAA.UntagResourceInput, options: SdkCallOptions): Promise; /** * Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment. */ updateEnvironment(input: AWS.MWAA.UpdateEnvironmentInput, options: SdkCallOptions): Promise; } export interface Neptune { /** * Associates an Identity and Access Management (IAM) role with an Neptune DB cluster. */ addRoleToDBCluster(input: AWS.Neptune.AddRoleToDBClusterMessage, options: SdkCallOptions): Promise<{}>; /** * Adds a source identifier to an existing event notification subscription. */ addSourceIdentifierToSubscription(input: AWS.Neptune.AddSourceIdentifierToSubscriptionMessage, options: SdkCallOptions): Promise; /** * Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune. */ addTagsToResource(input: AWS.Neptune.AddTagsToResourceMessage, options: SdkCallOptions): Promise<{}>; /** * Applies a pending maintenance action to a resource (for example, to a DB instance). */ applyPendingMaintenanceAction(input: AWS.Neptune.ApplyPendingMaintenanceActionMessage, options: SdkCallOptions): Promise; /** * Copies the specified DB cluster parameter group. */ copyDBClusterParameterGroup(input: AWS.Neptune.CopyDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. */ copyDBClusterSnapshot(input: AWS.Neptune.CopyDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Copies the specified DB parameter group. */ copyDBParameterGroup(input: AWS.Neptune.CopyDBParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance. Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false. */ createDBCluster(input: AWS.Neptune.CreateDBClusterMessage, options: SdkCallOptions): Promise; /** * Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster. */ createDBClusterEndpoint(input: AWS.Neptune.CreateDBClusterEndpointMessage, options: SdkCallOptions): Promise; /** * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. */ createDBClusterParameterGroup(input: AWS.Neptune.CreateDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a snapshot of a DB cluster. */ createDBClusterSnapshot(input: AWS.Neptune.CreateDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Creates a new DB instance. */ createDBInstance(input: AWS.Neptune.CreateDBInstanceMessage, options: SdkCallOptions): Promise; /** * Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. */ createDBParameterGroup(input: AWS.Neptune.CreateDBParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region. */ createDBSubnetGroup(input: AWS.Neptune.CreateDBSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account. */ createEventSubscription(input: AWS.Neptune.CreateEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database. */ createGlobalCluster(input: AWS.Neptune.CreateGlobalClusterMessage, options: SdkCallOptions): Promise; /** * The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its DeletionProtection field to False. */ deleteDBCluster(input: AWS.Neptune.DeleteDBClusterMessage, options: SdkCallOptions): Promise; /** * Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster. */ deleteDBClusterEndpoint(input: AWS.Neptune.DeleteDBClusterEndpointMessage, options: SdkCallOptions): Promise; /** * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. */ deleteDBClusterParameterGroup(input: AWS.Neptune.DeleteDBClusterParameterGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. */ deleteDBClusterSnapshot(input: AWS.Neptune.DeleteDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true. You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled. */ deleteDBInstance(input: AWS.Neptune.DeleteDBInstanceMessage, options: SdkCallOptions): Promise; /** * Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances. */ deleteDBParameterGroup(input: AWS.Neptune.DeleteDBParameterGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. */ deleteDBSubnetGroup(input: AWS.Neptune.DeleteDBSubnetGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes an event notification subscription. */ deleteEventSubscription(input: AWS.Neptune.DeleteEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Deletes a global database. The primary and all secondary clusters must already be detached or deleted first. */ deleteGlobalCluster(input: AWS.Neptune.DeleteGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Returns information about endpoints for an Amazon Neptune DB cluster. This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters. */ describeDBClusterEndpoints(input: AWS.Neptune.DescribeDBClusterEndpointsMessage, options: SdkCallOptions): Promise; /** * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. */ describeDBClusterParameterGroups(input: AWS.Neptune.DescribeDBClusterParameterGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the detailed parameter list for a particular DB cluster parameter group. */ describeDBClusterParameters(input: AWS.Neptune.DescribeDBClusterParametersMessage, options: SdkCallOptions): Promise; /** * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon accounts. To add or remove access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action. */ describeDBClusterSnapshotAttributes(input: AWS.Neptune.DescribeDBClusterSnapshotAttributesMessage, options: SdkCallOptions): Promise; /** * Returns information about DB cluster snapshots. This API action supports pagination. */ describeDBClusterSnapshots(input: AWS.Neptune.DescribeDBClusterSnapshotsMessage, options: SdkCallOptions): Promise; /** * Returns information about provisioned DB clusters, and supports pagination. This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters. */ describeDBClusters(input: AWS.Neptune.DescribeDBClustersMessage, options: SdkCallOptions): Promise; /** * Returns a list of the available DB engines. */ describeDBEngineVersions(input: AWS.Neptune.DescribeDBEngineVersionsMessage, options: SdkCallOptions): Promise; /** * Returns information about provisioned instances, and supports pagination. This operation can also return information for Amazon RDS instances and Amazon DocDB instances. */ describeDBInstances(input: AWS.Neptune.DescribeDBInstancesMessage, options: SdkCallOptions): Promise; /** * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group. */ describeDBParameterGroups(input: AWS.Neptune.DescribeDBParameterGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the detailed parameter list for a particular DB parameter group. */ describeDBParameters(input: AWS.Neptune.DescribeDBParametersMessage, options: SdkCallOptions): Promise; /** * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. */ describeDBSubnetGroups(input: AWS.Neptune.DescribeDBSubnetGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the default engine and system parameter information for the cluster database engine. */ describeEngineDefaultClusterParameters(input: AWS.Neptune.DescribeEngineDefaultClusterParametersMessage, options: SdkCallOptions): Promise; /** * Returns the default engine and system parameter information for the specified database engine. */ describeEngineDefaultParameters(input: AWS.Neptune.DescribeEngineDefaultParametersMessage, options: SdkCallOptions): Promise; /** * Displays a list of categories for all event source types, or, if specified, for a specified source type. */ describeEventCategories(input: AWS.Neptune.DescribeEventCategoriesMessage, options: SdkCallOptions): Promise; /** * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. */ describeEventSubscriptions(input: AWS.Neptune.DescribeEventSubscriptionsMessage, options: SdkCallOptions): Promise; /** * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. */ describeEvents(input: AWS.Neptune.DescribeEventsMessage, options: SdkCallOptions): Promise; /** * Returns information about Neptune global database clusters. This API supports pagination. */ describeGlobalClusters(input: AWS.Neptune.DescribeGlobalClustersMessage, options: SdkCallOptions): Promise; /** * Returns a list of orderable DB instance options for the specified engine. */ describeOrderableDBInstanceOptions(input: AWS.Neptune.DescribeOrderableDBInstanceOptionsMessage, options: SdkCallOptions): Promise; /** * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. */ describePendingMaintenanceActions(input: AWS.Neptune.DescribePendingMaintenanceActionsMessage, options: SdkCallOptions): Promise; /** * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. */ describeValidDBInstanceModifications(input: AWS.Neptune.DescribeValidDBInstanceModificationsMessage, options: SdkCallOptions): Promise; /** * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. */ failoverDBCluster(input: AWS.Neptune.FailoverDBClusterMessage, options: SdkCallOptions): Promise; /** * Initiates the failover process for a Neptune global database. A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database. This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology. */ failoverGlobalCluster(input: AWS.Neptune.FailoverGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Lists all tags on an Amazon Neptune resource. */ listTagsForResource(input: AWS.Neptune.ListTagsForResourceMessage, options: SdkCallOptions): Promise; /** * Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. */ modifyDBCluster(input: AWS.Neptune.ModifyDBClusterMessage, options: SdkCallOptions): Promise; /** * Modifies the properties of an endpoint in an Amazon Neptune DB cluster. */ modifyDBClusterEndpoint(input: AWS.Neptune.ModifyDBClusterEndpointMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. */ modifyDBClusterParameterGroup(input: AWS.Neptune.ModifyDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action. */ modifyDBClusterSnapshotAttribute(input: AWS.Neptune.ModifyDBClusterSnapshotAttributeMessage, options: SdkCallOptions): Promise; /** * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance. */ modifyDBInstance(input: AWS.Neptune.ModifyDBInstanceMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. */ modifyDBParameterGroup(input: AWS.Neptune.ModifyDBParameterGroupMessage, options: SdkCallOptions): Promise; /** * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region. */ modifyDBSubnetGroup(input: AWS.Neptune.ModifyDBSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action. */ modifyEventSubscription(input: AWS.Neptune.ModifyEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request. */ modifyGlobalCluster(input: AWS.Neptune.ModifyGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Not supported. */ promoteReadReplicaDBCluster(input: AWS.Neptune.PromoteReadReplicaDBClusterMessage, options: SdkCallOptions): Promise; /** * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. */ rebootDBInstance(input: AWS.Neptune.RebootDBInstanceMessage, options: SdkCallOptions): Promise; /** * Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster. */ removeFromGlobalCluster(input: AWS.Neptune.RemoveFromGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Disassociates an Identity and Access Management (IAM) role from a DB cluster. */ removeRoleFromDBCluster(input: AWS.Neptune.RemoveRoleFromDBClusterMessage, options: SdkCallOptions): Promise<{}>; /** * Removes a source identifier from an existing event notification subscription. */ removeSourceIdentifierFromSubscription(input: AWS.Neptune.RemoveSourceIdentifierFromSubscriptionMessage, options: SdkCallOptions): Promise; /** * Removes metadata tags from an Amazon Neptune resource. */ removeTagsFromResource(input: AWS.Neptune.RemoveTagsFromResourceMessage, options: SdkCallOptions): Promise<{}>; /** * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. */ resetDBClusterParameterGroup(input: AWS.Neptune.ResetDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. */ resetDBParameterGroup(input: AWS.Neptune.ResetDBParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. */ restoreDBClusterFromSnapshot(input: AWS.Neptune.RestoreDBClusterFromSnapshotMessage, options: SdkCallOptions): Promise; /** * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. */ restoreDBClusterToPointInTime(input: AWS.Neptune.RestoreDBClusterToPointInTimeMessage, options: SdkCallOptions): Promise; /** * Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API. */ startDBCluster(input: AWS.Neptune.StartDBClusterMessage, options: SdkCallOptions): Promise; /** * Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups. Neptune also retains the transaction logs so you can do a point-in-time restore if necessary. */ stopDBCluster(input: AWS.Neptune.StopDBClusterMessage, options: SdkCallOptions): Promise; } export interface NetworkFirewall { /** * Associates a FirewallPolicy to a Firewall. A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls. */ associateFirewallPolicy(input: AWS.NetworkFirewall.AssociateFirewallPolicyRequest, options: SdkCallOptions): Promise; /** * Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans. This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint. */ associateSubnets(input: AWS.NetworkFirewall.AssociateSubnetsRequest, options: SdkCallOptions): Promise; /** * Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC. The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource. After you create a firewall, you can provide additional settings, like the logging configuration. To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection. To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about firewalls, use ListFirewalls and DescribeFirewall. */ createFirewall(input: AWS.NetworkFirewall.CreateFirewallRequest, options: SdkCallOptions): Promise; /** * Creates the firewall policy for the firewall according to the specifications. An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls. */ createFirewallPolicy(input: AWS.NetworkFirewall.CreateFirewallPolicyRequest, options: SdkCallOptions): Promise; /** * Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags. You provide your rule group specification in your request using either RuleGroup or Rules. */ createRuleGroup(input: AWS.NetworkFirewall.CreateRuleGroupRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection flag to be FALSE. You can't revert this operation. You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely. To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall. */ deleteFirewall(input: AWS.NetworkFirewall.DeleteFirewallRequest, options: SdkCallOptions): Promise; /** * Deletes the specified FirewallPolicy. */ deleteFirewallPolicy(input: AWS.NetworkFirewall.DeleteFirewallPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a resource policy that you created in a PutResourcePolicy request. */ deleteResourcePolicy(input: AWS.NetworkFirewall.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes the specified RuleGroup. */ deleteRuleGroup(input: AWS.NetworkFirewall.DeleteRuleGroupRequest, options: SdkCallOptions): Promise; /** * Returns the data objects for the specified firewall. */ describeFirewall(input: AWS.NetworkFirewall.DescribeFirewallRequest, options: SdkCallOptions): Promise; /** * Returns the data objects for the specified firewall policy. */ describeFirewallPolicy(input: AWS.NetworkFirewall.DescribeFirewallPolicyRequest, options: SdkCallOptions): Promise; /** * Returns the logging configuration for the specified firewall. */ describeLoggingConfiguration(input: AWS.NetworkFirewall.DescribeLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves a resource policy that you created in a PutResourcePolicy request. */ describeResourcePolicy(input: AWS.NetworkFirewall.DescribeResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Returns the data objects for the specified rule group. */ describeRuleGroup(input: AWS.NetworkFirewall.DescribeRuleGroupRequest, options: SdkCallOptions): Promise; /** * High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup. */ describeRuleGroupMetadata(input: AWS.NetworkFirewall.DescribeRuleGroupMetadataRequest, options: SdkCallOptions): Promise; /** * Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing. */ disassociateSubnets(input: AWS.NetworkFirewall.DisassociateSubnetsRequest, options: SdkCallOptions): Promise; /** * Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list. */ listFirewallPolicies(input: AWS.NetworkFirewall.ListFirewallPoliciesRequest, options: SdkCallOptions): Promise; /** * Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs. Depending on your setting for max results and the number of firewalls, a single call might not return the full list. */ listFirewalls(input: AWS.NetworkFirewall.ListFirewallsRequest, options: SdkCallOptions): Promise; /** * Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list. */ listRuleGroups(input: AWS.NetworkFirewall.ListRuleGroupsRequest, options: SdkCallOptions): Promise; /** * Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource. You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups. */ listTagsForResource(input: AWS.NetworkFirewall.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall. Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform. When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy. GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations. AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share. For additional information about resource sharing using RAM, see Resource Access Manager User Guide. */ putResourcePolicy(input: AWS.NetworkFirewall.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource. You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups. */ tagResource(input: AWS.NetworkFirewall.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource. You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups. */ untagResource(input: AWS.NetworkFirewall.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use. */ updateFirewallDeleteProtection(input: AWS.NetworkFirewall.UpdateFirewallDeleteProtectionRequest, options: SdkCallOptions): Promise; /** * Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it. */ updateFirewallDescription(input: AWS.NetworkFirewall.UpdateFirewallDescriptionRequest, options: SdkCallOptions): Promise; /** * A complex type that contains settings for encryption of your firewall resources. */ updateFirewallEncryptionConfiguration(input: AWS.NetworkFirewall.UpdateFirewallEncryptionConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the properties of the specified firewall policy. */ updateFirewallPolicy(input: AWS.NetworkFirewall.UpdateFirewallPolicyRequest, options: SdkCallOptions): Promise; /** * Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use. */ updateFirewallPolicyChangeProtection(input: AWS.NetworkFirewall.UpdateFirewallPolicyChangeProtectionRequest, options: SdkCallOptions): Promise; /** * Sets the logging configuration for the specified firewall. To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object. You can perform only one of the following actions in any call to UpdateLoggingConfiguration: Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs. Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs. Change the LogDestination setting in a single LogDestinationConfig array element. You can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these settings, delete the existing LogDestinationConfig object and create a new one, using two separate calls to this update operation. */ updateLoggingConfiguration(input: AWS.NetworkFirewall.UpdateLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group. To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call. */ updateRuleGroup(input: AWS.NetworkFirewall.UpdateRuleGroupRequest, options: SdkCallOptions): Promise; updateSubnetChangeProtection(input: AWS.NetworkFirewall.UpdateSubnetChangeProtectionRequest, options: SdkCallOptions): Promise; } export interface NetworkManager { /** * Accepts a core network attachment request. Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network. */ acceptAttachment(input: AWS.NetworkManager.AcceptAttachmentRequest, options: SdkCallOptions): Promise; /** * Associates a core network Connect peer with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate core network Connect peers that have been created on a core network Connect attachment on a core network. */ associateConnectPeer(input: AWS.NetworkManager.AssociateConnectPeerRequest, options: SdkCallOptions): Promise; /** * Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate customer gateways that are connected to a VPN attachment on a transit gateway or core network registered in your global network. When you register a transit gateway or core network, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id. You cannot associate a customer gateway with more than one device and link. */ associateCustomerGateway(input: AWS.NetworkManager.AssociateCustomerGatewayRequest, options: SdkCallOptions): Promise; /** * Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site. */ associateLink(input: AWS.NetworkManager.AssociateLinkRequest, options: SdkCallOptions): Promise; /** * Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network. You cannot associate a transit gateway Connect peer with more than one device and link. */ associateTransitGatewayConnectPeer(input: AWS.NetworkManager.AssociateTransitGatewayConnectPeerRequest, options: SdkCallOptions): Promise; /** * Creates a core network Connect attachment from a specified core network attachment. A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism. */ createConnectAttachment(input: AWS.NetworkManager.CreateConnectAttachmentRequest, options: SdkCallOptions): Promise; /** * Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6). */ createConnectPeer(input: AWS.NetworkManager.CreateConnectPeerRequest, options: SdkCallOptions): Promise; /** * Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network. */ createConnection(input: AWS.NetworkManager.CreateConnectionRequest, options: SdkCallOptions): Promise; /** * Creates a core network as part of your global network, and optionally, with a core network policy. */ createCoreNetwork(input: AWS.NetworkManager.CreateCoreNetworkRequest, options: SdkCallOptions): Promise; /** * Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console. */ createDevice(input: AWS.NetworkManager.CreateDeviceRequest, options: SdkCallOptions): Promise; /** * Creates a new, empty global network. */ createGlobalNetwork(input: AWS.NetworkManager.CreateGlobalNetworkRequest, options: SdkCallOptions): Promise; /** * Creates a new link for a specified site. */ createLink(input: AWS.NetworkManager.CreateLinkRequest, options: SdkCallOptions): Promise; /** * Creates a new site in a global network. */ createSite(input: AWS.NetworkManager.CreateSiteRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network. */ createSiteToSiteVpnAttachment(input: AWS.NetworkManager.CreateSiteToSiteVpnAttachmentRequest, options: SdkCallOptions): Promise; /** * Creates a transit gateway peering connection. */ createTransitGatewayPeering(input: AWS.NetworkManager.CreateTransitGatewayPeeringRequest, options: SdkCallOptions): Promise; /** * Creates a transit gateway route table attachment. */ createTransitGatewayRouteTableAttachment(input: AWS.NetworkManager.CreateTransitGatewayRouteTableAttachmentRequest, options: SdkCallOptions): Promise; /** * Creates a VPC attachment on an edge location of a core network. */ createVpcAttachment(input: AWS.NetworkManager.CreateVpcAttachmentRequest, options: SdkCallOptions): Promise; /** * Deletes an attachment. Supports all attachment types. */ deleteAttachment(input: AWS.NetworkManager.DeleteAttachmentRequest, options: SdkCallOptions): Promise; /** * Deletes a Connect peer. */ deleteConnectPeer(input: AWS.NetworkManager.DeleteConnectPeerRequest, options: SdkCallOptions): Promise; /** * Deletes the specified connection in your global network. */ deleteConnection(input: AWS.NetworkManager.DeleteConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network. */ deleteCoreNetwork(input: AWS.NetworkManager.DeleteCoreNetworkRequest, options: SdkCallOptions): Promise; /** * Deletes a policy version from a core network. You can't delete the current LIVE policy. */ deleteCoreNetworkPolicyVersion(input: AWS.NetworkManager.DeleteCoreNetworkPolicyVersionRequest, options: SdkCallOptions): Promise; /** * Deletes an existing device. You must first disassociate the device from any links and customer gateways. */ deleteDevice(input: AWS.NetworkManager.DeleteDeviceRequest, options: SdkCallOptions): Promise; /** * Deletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete any core networks. */ deleteGlobalNetwork(input: AWS.NetworkManager.DeleteGlobalNetworkRequest, options: SdkCallOptions): Promise; /** * Deletes an existing link. You must first disassociate the link from any devices and customer gateways. */ deleteLink(input: AWS.NetworkManager.DeleteLinkRequest, options: SdkCallOptions): Promise; /** * Deletes an existing peering connection. */ deletePeering(input: AWS.NetworkManager.DeletePeeringRequest, options: SdkCallOptions): Promise; /** * Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy. */ deleteResourcePolicy(input: AWS.NetworkManager.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes an existing site. The site cannot be associated with any device or link. */ deleteSite(input: AWS.NetworkManager.DeleteSiteRequest, options: SdkCallOptions): Promise; /** * Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations. */ deregisterTransitGateway(input: AWS.NetworkManager.DeregisterTransitGatewayRequest, options: SdkCallOptions): Promise; /** * Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations. */ describeGlobalNetworks(input: AWS.NetworkManager.DescribeGlobalNetworksRequest, options: SdkCallOptions): Promise; /** * Disassociates a core network Connect peer from a device and a link. */ disassociateConnectPeer(input: AWS.NetworkManager.DisassociateConnectPeerRequest, options: SdkCallOptions): Promise; /** * Disassociates a customer gateway from a device and a link. */ disassociateCustomerGateway(input: AWS.NetworkManager.DisassociateCustomerGatewayRequest, options: SdkCallOptions): Promise; /** * Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link. */ disassociateLink(input: AWS.NetworkManager.DisassociateLinkRequest, options: SdkCallOptions): Promise; /** * Disassociates a transit gateway Connect peer from a device and link. */ disassociateTransitGatewayConnectPeer(input: AWS.NetworkManager.DisassociateTransitGatewayConnectPeerRequest, options: SdkCallOptions): Promise; /** * Executes a change set on your core network. Deploys changes globally based on the policy submitted.. */ executeCoreNetworkChangeSet(input: AWS.NetworkManager.ExecuteCoreNetworkChangeSetRequest, options: SdkCallOptions): Promise; /** * Returns information about a core network Connect attachment. */ getConnectAttachment(input: AWS.NetworkManager.GetConnectAttachmentRequest, options: SdkCallOptions): Promise; /** * Returns information about a core network Connect peer. */ getConnectPeer(input: AWS.NetworkManager.GetConnectPeerRequest, options: SdkCallOptions): Promise; /** * Returns information about a core network Connect peer associations. */ getConnectPeerAssociations(input: AWS.NetworkManager.GetConnectPeerAssociationsRequest, options: SdkCallOptions): Promise; /** * Gets information about one or more of your connections in a global network. */ getConnections(input: AWS.NetworkManager.GetConnectionsRequest, options: SdkCallOptions): Promise; /** * Returns information about the LIVE policy for a core network. */ getCoreNetwork(input: AWS.NetworkManager.GetCoreNetworkRequest, options: SdkCallOptions): Promise; /** * Returns information about a core network change event. */ getCoreNetworkChangeEvents(input: AWS.NetworkManager.GetCoreNetworkChangeEventsRequest, options: SdkCallOptions): Promise; /** * Returns a change set between the LIVE core network policy and a submitted policy. */ getCoreNetworkChangeSet(input: AWS.NetworkManager.GetCoreNetworkChangeSetRequest, options: SdkCallOptions): Promise; /** * Returns details about a core network policy. You can get details about your current live policy or any previous policy version. */ getCoreNetworkPolicy(input: AWS.NetworkManager.GetCoreNetworkPolicyRequest, options: SdkCallOptions): Promise; /** * Gets the association information for customer gateways that are associated with devices and links in your global network. */ getCustomerGatewayAssociations(input: AWS.NetworkManager.GetCustomerGatewayAssociationsRequest, options: SdkCallOptions): Promise; /** * Gets information about one or more of your devices in a global network. */ getDevices(input: AWS.NetworkManager.GetDevicesRequest, options: SdkCallOptions): Promise; /** * Gets the link associations for a device or a link. Either the device ID or the link ID must be specified. */ getLinkAssociations(input: AWS.NetworkManager.GetLinkAssociationsRequest, options: SdkCallOptions): Promise; /** * Gets information about one or more links in a specified global network. If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request. */ getLinks(input: AWS.NetworkManager.GetLinksRequest, options: SdkCallOptions): Promise; /** * Gets the count of network resources, by resource type, for the specified global network. */ getNetworkResourceCounts(input: AWS.NetworkManager.GetNetworkResourceCountsRequest, options: SdkCallOptions): Promise; /** * Gets the network resource relationships for the specified global network. */ getNetworkResourceRelationships(input: AWS.NetworkManager.GetNetworkResourceRelationshipsRequest, options: SdkCallOptions): Promise; /** * Describes the network resources for the specified global network. The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys. */ getNetworkResources(input: AWS.NetworkManager.GetNetworkResourcesRequest, options: SdkCallOptions): Promise; /** * Gets the network routes of the specified global network. */ getNetworkRoutes(input: AWS.NetworkManager.GetNetworkRoutesRequest, options: SdkCallOptions): Promise; /** * Gets the network telemetry of the specified global network. */ getNetworkTelemetry(input: AWS.NetworkManager.GetNetworkTelemetryRequest, options: SdkCallOptions): Promise; /** * Returns information about a resource policy. */ getResourcePolicy(input: AWS.NetworkManager.GetResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified route analysis. */ getRouteAnalysis(input: AWS.NetworkManager.GetRouteAnalysisRequest, options: SdkCallOptions): Promise; /** * Returns information about a site-to-site VPN attachment. */ getSiteToSiteVpnAttachment(input: AWS.NetworkManager.GetSiteToSiteVpnAttachmentRequest, options: SdkCallOptions): Promise; /** * Gets information about one or more of your sites in a global network. */ getSites(input: AWS.NetworkManager.GetSitesRequest, options: SdkCallOptions): Promise; /** * Gets information about one or more of your transit gateway Connect peer associations in a global network. */ getTransitGatewayConnectPeerAssociations(input: AWS.NetworkManager.GetTransitGatewayConnectPeerAssociationsRequest, options: SdkCallOptions): Promise; /** * Returns information about a transit gateway peer. */ getTransitGatewayPeering(input: AWS.NetworkManager.GetTransitGatewayPeeringRequest, options: SdkCallOptions): Promise; /** * Gets information about the transit gateway registrations in a specified global network. */ getTransitGatewayRegistrations(input: AWS.NetworkManager.GetTransitGatewayRegistrationsRequest, options: SdkCallOptions): Promise; /** * Returns information about a transit gateway route table attachment. */ getTransitGatewayRouteTableAttachment(input: AWS.NetworkManager.GetTransitGatewayRouteTableAttachmentRequest, options: SdkCallOptions): Promise; /** * Returns information about a VPC attachment. */ getVpcAttachment(input: AWS.NetworkManager.GetVpcAttachmentRequest, options: SdkCallOptions): Promise; /** * Returns a list of core network attachments. */ listAttachments(input: AWS.NetworkManager.ListAttachmentsRequest, options: SdkCallOptions): Promise; /** * Returns a list of core network Connect peers. */ listConnectPeers(input: AWS.NetworkManager.ListConnectPeersRequest, options: SdkCallOptions): Promise; /** * Returns a list of core network policy versions. */ listCoreNetworkPolicyVersions(input: AWS.NetworkManager.ListCoreNetworkPolicyVersionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of owned and shared core networks. */ listCoreNetworks(input: AWS.NetworkManager.ListCoreNetworksRequest, options: SdkCallOptions): Promise; /** * Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization. */ listOrganizationServiceAccessStatus(input: AWS.NetworkManager.ListOrganizationServiceAccessStatusRequest, options: SdkCallOptions): Promise; /** * Lists the peerings for a core network. */ listPeerings(input: AWS.NetworkManager.ListPeeringsRequest, options: SdkCallOptions): Promise; /** * Lists the tags for a specified resource. */ listTagsForResource(input: AWS.NetworkManager.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy. */ putCoreNetworkPolicy(input: AWS.NetworkManager.PutCoreNetworkPolicyRequest, options: SdkCallOptions): Promise; /** * Creates or updates a resource policy. */ putResourcePolicy(input: AWS.NetworkManager.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Registers a transit gateway in your global network. The transit gateway can be in any Amazon Web Services Region, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network. */ registerTransitGateway(input: AWS.NetworkManager.RegisterTransitGatewayRequest, options: SdkCallOptions): Promise; /** * Rejects a core network attachment request. */ rejectAttachment(input: AWS.NetworkManager.RejectAttachmentRequest, options: SdkCallOptions): Promise; /** * Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy. */ restoreCoreNetworkPolicyVersion(input: AWS.NetworkManager.RestoreCoreNetworkPolicyVersionRequest, options: SdkCallOptions): Promise; /** * Enables for the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization. */ startOrganizationServiceAccessUpdate(input: AWS.NetworkManager.StartOrganizationServiceAccessUpdateRequest, options: SdkCallOptions): Promise; /** * Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer. */ startRouteAnalysis(input: AWS.NetworkManager.StartRouteAnalysisRequest, options: SdkCallOptions): Promise; /** * Tags a specified resource. */ tagResource(input: AWS.NetworkManager.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a specified resource. */ untagResource(input: AWS.NetworkManager.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string. */ updateConnection(input: AWS.NetworkManager.UpdateConnectionRequest, options: SdkCallOptions): Promise; /** * Updates the description of a core network. */ updateCoreNetwork(input: AWS.NetworkManager.UpdateCoreNetworkRequest, options: SdkCallOptions): Promise; /** * Updates the details for an existing device. To remove information for any of the parameters, specify an empty string. */ updateDevice(input: AWS.NetworkManager.UpdateDeviceRequest, options: SdkCallOptions): Promise; /** * Updates an existing global network. To remove information for any of the parameters, specify an empty string. */ updateGlobalNetwork(input: AWS.NetworkManager.UpdateGlobalNetworkRequest, options: SdkCallOptions): Promise; /** * Updates the details for an existing link. To remove information for any of the parameters, specify an empty string. */ updateLink(input: AWS.NetworkManager.UpdateLinkRequest, options: SdkCallOptions): Promise; /** * Updates the resource metadata for the specified global network. */ updateNetworkResourceMetadata(input: AWS.NetworkManager.UpdateNetworkResourceMetadataRequest, options: SdkCallOptions): Promise; /** * Updates the information for an existing site. To remove information for any of the parameters, specify an empty string. */ updateSite(input: AWS.NetworkManager.UpdateSiteRequest, options: SdkCallOptions): Promise; /** * Updates a VPC attachment. */ updateVpcAttachment(input: AWS.NetworkManager.UpdateVpcAttachmentRequest, options: SdkCallOptions): Promise; } export interface Nimble { /** * Accept EULAs. */ acceptEulas(input: AWS.Nimble.AcceptEulasRequest, options: SdkCallOptions): Promise; /** * Create a launch profile. */ createLaunchProfile(input: AWS.Nimble.CreateLaunchProfileRequest, options: SdkCallOptions): Promise; /** * Creates a streaming image resource in a studio. */ createStreamingImage(input: AWS.Nimble.CreateStreamingImageRequest, options: SdkCallOptions): Promise; /** * Creates a streaming session in a studio. After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY. */ createStreamingSession(input: AWS.Nimble.CreateStreamingSessionRequest, options: SdkCallOptions): Promise; /** * Creates a streaming session stream for a streaming session. After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY. */ createStreamingSessionStream(input: AWS.Nimble.CreateStreamingSessionStreamRequest, options: SdkCallOptions): Promise; /** * Create a new Studio. When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal. The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly. The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly. You may optionally specify a KMS key in the StudioEncryptionConfiguration. In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage. When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys. If you delete this grant, the studio will no longer be accessible to your portal users. If you delete the studio KMS key, your studio will no longer be accessible. */ createStudio(input: AWS.Nimble.CreateStudioRequest, options: SdkCallOptions): Promise; /** * Creates a studio component resource. */ createStudioComponent(input: AWS.Nimble.CreateStudioComponentRequest, options: SdkCallOptions): Promise; /** * Permanently delete a launch profile. */ deleteLaunchProfile(input: AWS.Nimble.DeleteLaunchProfileRequest, options: SdkCallOptions): Promise; /** * Delete a user from launch profile membership. */ deleteLaunchProfileMember(input: AWS.Nimble.DeleteLaunchProfileMemberRequest, options: SdkCallOptions): Promise; /** * Delete streaming image. */ deleteStreamingImage(input: AWS.Nimble.DeleteStreamingImageRequest, options: SdkCallOptions): Promise; /** * Deletes streaming session resource. After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state. A streaming session will count against your streaming session quota until it is marked DELETED. */ deleteStreamingSession(input: AWS.Nimble.DeleteStreamingSessionRequest, options: SdkCallOptions): Promise; /** * Delete a studio resource. */ deleteStudio(input: AWS.Nimble.DeleteStudioRequest, options: SdkCallOptions): Promise; /** * Deletes a studio component resource. */ deleteStudioComponent(input: AWS.Nimble.DeleteStudioComponentRequest, options: SdkCallOptions): Promise; /** * Delete a user from studio membership. */ deleteStudioMember(input: AWS.Nimble.DeleteStudioMemberRequest, options: SdkCallOptions): Promise; /** * Get Eula. */ getEula(input: AWS.Nimble.GetEulaRequest, options: SdkCallOptions): Promise; /** * Get a launch profile. */ getLaunchProfile(input: AWS.Nimble.GetLaunchProfileRequest, options: SdkCallOptions): Promise; /** * Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile. */ getLaunchProfileDetails(input: AWS.Nimble.GetLaunchProfileDetailsRequest, options: SdkCallOptions): Promise; /** * Get a launch profile initialization. */ getLaunchProfileInitialization(input: AWS.Nimble.GetLaunchProfileInitializationRequest, options: SdkCallOptions): Promise; /** * Get a user persona in launch profile membership. */ getLaunchProfileMember(input: AWS.Nimble.GetLaunchProfileMemberRequest, options: SdkCallOptions): Promise; /** * Get streaming image. */ getStreamingImage(input: AWS.Nimble.GetStreamingImageRequest, options: SdkCallOptions): Promise; /** * Gets StreamingSession resource. Invoke this operation to poll for a streaming session state while creating or deleting a session. */ getStreamingSession(input: AWS.Nimble.GetStreamingSessionRequest, options: SdkCallOptions): Promise; /** * Gets a StreamingSessionStream for a streaming session. Invoke this operation to poll the resource after invoking CreateStreamingSessionStream. After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client. */ getStreamingSessionStream(input: AWS.Nimble.GetStreamingSessionStreamRequest, options: SdkCallOptions): Promise; /** * Get a Studio resource. */ getStudio(input: AWS.Nimble.GetStudioRequest, options: SdkCallOptions): Promise; /** * Gets a studio component resource. */ getStudioComponent(input: AWS.Nimble.GetStudioComponentRequest, options: SdkCallOptions): Promise; /** * Get a user's membership in a studio. */ getStudioMember(input: AWS.Nimble.GetStudioMemberRequest, options: SdkCallOptions): Promise; /** * List Eula Acceptances. */ listEulaAcceptances(input: AWS.Nimble.ListEulaAcceptancesRequest, options: SdkCallOptions): Promise; /** * List Eulas. */ listEulas(input: AWS.Nimble.ListEulasRequest, options: SdkCallOptions): Promise; /** * Get all users in a given launch profile membership. */ listLaunchProfileMembers(input: AWS.Nimble.ListLaunchProfileMembersRequest, options: SdkCallOptions): Promise; /** * List all the launch profiles a studio. */ listLaunchProfiles(input: AWS.Nimble.ListLaunchProfilesRequest, options: SdkCallOptions): Promise; /** * List the streaming image resources available to this studio. This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio. */ listStreamingImages(input: AWS.Nimble.ListStreamingImagesRequest, options: SdkCallOptions): Promise; /** * Lists the streaming sessions in a studio. */ listStreamingSessions(input: AWS.Nimble.ListStreamingSessionsRequest, options: SdkCallOptions): Promise; /** * Lists the StudioComponents in a studio. */ listStudioComponents(input: AWS.Nimble.ListStudioComponentsRequest, options: SdkCallOptions): Promise; /** * Get all users in a given studio membership. ListStudioMembers only returns admin members. */ listStudioMembers(input: AWS.Nimble.ListStudioMembersRequest, options: SdkCallOptions): Promise; /** * List studios in your Amazon Web Services account in the requested Amazon Web Services Region. */ listStudios(input: AWS.Nimble.ListStudiosRequest, options: SdkCallOptions): Promise; /** * Gets the tags for a resource, given its Amazon Resource Names (ARN). This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself. */ listTagsForResource(input: AWS.Nimble.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Add/update users with given persona to launch profile membership. */ putLaunchProfileMembers(input: AWS.Nimble.PutLaunchProfileMembersRequest, options: SdkCallOptions): Promise; /** * Add/update users with given persona to studio membership. */ putStudioMembers(input: AWS.Nimble.PutStudioMembersRequest, options: SdkCallOptions): Promise; /** * Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states. */ startStreamingSession(input: AWS.Nimble.StartStreamingSessionRequest, options: SdkCallOptions): Promise; /** * Repairs the IAM Identity Center configuration for a given studio. If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error. If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the READY state. After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio. */ startStudioSSOConfigurationRepair(input: AWS.Nimble.StartStudioSSOConfigurationRepairRequest, options: SdkCallOptions): Promise; /** * Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states. */ stopStreamingSession(input: AWS.Nimble.StopStreamingSessionRequest, options: SdkCallOptions): Promise; /** * Creates tags for a resource, given its ARN. */ tagResource(input: AWS.Nimble.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes the tags for a resource. */ untagResource(input: AWS.Nimble.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update a launch profile. */ updateLaunchProfile(input: AWS.Nimble.UpdateLaunchProfileRequest, options: SdkCallOptions): Promise; /** * Update a user persona in launch profile membership. */ updateLaunchProfileMember(input: AWS.Nimble.UpdateLaunchProfileMemberRequest, options: SdkCallOptions): Promise; /** * Update streaming image. */ updateStreamingImage(input: AWS.Nimble.UpdateStreamingImageRequest, options: SdkCallOptions): Promise; /** * Update a Studio resource. Currently, this operation only supports updating the displayName of your studio. */ updateStudio(input: AWS.Nimble.UpdateStudioRequest, options: SdkCallOptions): Promise; /** * Updates a studio component resource. */ updateStudioComponent(input: AWS.Nimble.UpdateStudioComponentRequest, options: SdkCallOptions): Promise; } export interface OpenSearch { /** * Allows the remote domain owner to accept an inbound cross-cluster connection request. */ acceptInboundConnection(input: AWS.OpenSearch.AcceptInboundConnectionRequest, options: SdkCallOptions): Promise; /** * Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information. */ addTags(input: AWS.OpenSearch.AddTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Associates a package with an Amazon OpenSearch Service domain. */ associatePackage(input: AWS.OpenSearch.AssociatePackageRequest, options: SdkCallOptions): Promise; /** * Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state. */ cancelServiceSoftwareUpdate(input: AWS.OpenSearch.CancelServiceSoftwareUpdateRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide. */ createDomain(input: AWS.OpenSearch.CreateDomainRequest, options: SdkCallOptions): Promise; /** * Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain. */ createOutboundConnection(input: AWS.OpenSearch.CreateOutboundConnectionRequest, options: SdkCallOptions): Promise; /** * Create a package for use with Amazon OpenSearch Service domains. */ createPackage(input: AWS.OpenSearch.CreatePackageRequest, options: SdkCallOptions): Promise; /** * Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered. */ deleteDomain(input: AWS.OpenSearch.DeleteDomainRequest, options: SdkCallOptions): Promise; /** * Allows the remote domain owner to delete an existing inbound cross-cluster connection. */ deleteInboundConnection(input: AWS.OpenSearch.DeleteInboundConnectionRequest, options: SdkCallOptions): Promise; /** * Allows the local domain owner to delete an existing outbound cross-cluster connection. */ deleteOutboundConnection(input: AWS.OpenSearch.DeleteOutboundConnectionRequest, options: SdkCallOptions): Promise; /** * Deletes the package. */ deletePackage(input: AWS.OpenSearch.DeletePackageRequest, options: SdkCallOptions): Promise; /** * Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN. */ describeDomain(input: AWS.OpenSearch.DescribeDomainRequest, options: SdkCallOptions): Promise; /** * Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date. */ describeDomainAutoTunes(input: AWS.OpenSearch.DescribeDomainAutoTunesRequest, options: SdkCallOptions): Promise; /** * Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages. */ describeDomainChangeProgress(input: AWS.OpenSearch.DescribeDomainChangeProgressRequest, options: SdkCallOptions): Promise; /** * Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options. */ describeDomainConfig(input: AWS.OpenSearch.DescribeDomainConfigRequest, options: SdkCallOptions): Promise; /** * Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN. */ describeDomains(input: AWS.OpenSearch.DescribeDomainsRequest, options: SdkCallOptions): Promise; /** * Lists all the inbound cross-cluster connections for a remote domain. */ describeInboundConnections(input: AWS.OpenSearch.DescribeInboundConnectionsRequest, options: SdkCallOptions): Promise; /** * Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify. */ describeInstanceTypeLimits(input: AWS.OpenSearch.DescribeInstanceTypeLimitsRequest, options: SdkCallOptions): Promise; /** * Lists all the outbound cross-cluster connections for a local domain. */ describeOutboundConnections(input: AWS.OpenSearch.DescribeOutboundConnectionsRequest, options: SdkCallOptions): Promise; /** * Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination. */ describePackages(input: AWS.OpenSearch.DescribePackagesRequest, options: SdkCallOptions): Promise; /** * Lists available reserved OpenSearch instance offerings. */ describeReservedInstanceOfferings(input: AWS.OpenSearch.DescribeReservedInstanceOfferingsRequest, options: SdkCallOptions): Promise; /** * Returns information about reserved OpenSearch instances for this account. */ describeReservedInstances(input: AWS.OpenSearch.DescribeReservedInstancesRequest, options: SdkCallOptions): Promise; /** * Dissociates a package from the Amazon OpenSearch Service domain. */ dissociatePackage(input: AWS.OpenSearch.DissociatePackageRequest, options: SdkCallOptions): Promise; /** * Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain. */ getCompatibleVersions(input: AWS.OpenSearch.GetCompatibleVersionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of package versions, along with their creation time and commit message. */ getPackageVersionHistory(input: AWS.OpenSearch.GetPackageVersionHistoryRequest, options: SdkCallOptions): Promise; /** * Retrieves the complete history of the last 10 upgrades performed on the domain. */ getUpgradeHistory(input: AWS.OpenSearch.GetUpgradeHistoryRequest, options: SdkCallOptions): Promise; /** * Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain. */ getUpgradeStatus(input: AWS.OpenSearch.GetUpgradeStatusRequest, options: SdkCallOptions): Promise; /** * Returns the names of all domains owned by the current user's account. */ listDomainNames(input: AWS.OpenSearch.ListDomainNamesRequest, options: SdkCallOptions): Promise; /** * Lists all Amazon OpenSearch Service domains associated with the package. */ listDomainsForPackage(input: AWS.OpenSearch.ListDomainsForPackageRequest, options: SdkCallOptions): Promise; listInstanceTypeDetails(input: AWS.OpenSearch.ListInstanceTypeDetailsRequest, options: SdkCallOptions): Promise; /** * Lists all packages associated with the Amazon OpenSearch Service domain. */ listPackagesForDomain(input: AWS.OpenSearch.ListPackagesForDomainRequest, options: SdkCallOptions): Promise; /** * Returns all tags for the given domain. */ listTags(input: AWS.OpenSearch.ListTagsRequest, options: SdkCallOptions): Promise; /** * List all supported versions of OpenSearch and Elasticsearch. */ listVersions(input: AWS.OpenSearch.ListVersionsRequest, options: SdkCallOptions): Promise; /** * Allows you to purchase reserved OpenSearch instances. */ purchaseReservedInstanceOffering(input: AWS.OpenSearch.PurchaseReservedInstanceOfferingRequest, options: SdkCallOptions): Promise; /** * Allows the remote domain owner to reject an inbound cross-cluster connection request. */ rejectInboundConnection(input: AWS.OpenSearch.RejectInboundConnectionRequest, options: SdkCallOptions): Promise; /** * Removes the specified set of tags from the given domain. */ removeTags(input: AWS.OpenSearch.RemoveTagsRequest, options: SdkCallOptions): Promise<{}>; /** * Schedules a service software update for an Amazon OpenSearch Service domain. */ startServiceSoftwareUpdate(input: AWS.OpenSearch.StartServiceSoftwareUpdateRequest, options: SdkCallOptions): Promise; /** * Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances. */ updateDomainConfig(input: AWS.OpenSearch.UpdateDomainConfigRequest, options: SdkCallOptions): Promise; /** * Updates a package for use with Amazon OpenSearch Service domains. */ updatePackage(input: AWS.OpenSearch.UpdatePackageRequest, options: SdkCallOptions): Promise; /** * Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch. */ upgradeDomain(input: AWS.OpenSearch.UpgradeDomainRequest, options: SdkCallOptions): Promise; } export interface OpsWorks { /** * Assign a registered instance to a layer. You can assign registered on-premises instances to any layer type. You can assign registered Amazon EC2 instances only to custom layers. You cannot use this action with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ assignInstance(input: AWS.OpsWorks.AssignInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ assignVolume(input: AWS.OpsWorks.AssignVolumeRequest, options: SdkCallOptions): Promise<{}>; /** * Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ associateElasticIp(input: AWS.OpsWorks.AssociateElasticIpRequest, options: SdkCallOptions): Promise<{}>; /** * Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing. You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ attachElasticLoadBalancer(input: AWS.OpsWorks.AttachElasticLoadBalancerRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ cloneStack(input: AWS.OpsWorks.CloneStackRequest, options: SdkCallOptions): Promise; /** * Creates an app for a specified stack. For more information, see Creating Apps. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ createApp(input: AWS.OpsWorks.CreateAppRequest, options: SdkCallOptions): Promise; /** * Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands. Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ createDeployment(input: AWS.OpsWorks.CreateDeploymentRequest, options: SdkCallOptions): Promise; /** * Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ createInstance(input: AWS.OpsWorks.CreateInstanceRequest, options: SdkCallOptions): Promise; /** * Creates a layer. For more information, see How to Create a Layer. You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ createLayer(input: AWS.OpsWorks.CreateLayerRequest, options: SdkCallOptions): Promise; /** * Creates a new stack. For more information, see Create a New Stack. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ createStack(input: AWS.OpsWorks.CreateStackRequest, options: SdkCallOptions): Promise; /** * Creates a new user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ createUserProfile(input: AWS.OpsWorks.CreateUserProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a specified app. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ deleteApp(input: AWS.OpsWorks.DeleteAppRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. For more information, see Deleting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ deleteInstance(input: AWS.OpsWorks.DeleteInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ deleteLayer(input: AWS.OpsWorks.DeleteLayerRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ deleteStack(input: AWS.OpsWorks.DeleteStackRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ deleteUserProfile(input: AWS.OpsWorks.DeleteUserProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html. */ deregisterEcsCluster(input: AWS.OpsWorks.DeregisterEcsClusterRequest, options: SdkCallOptions): Promise<{}>; /** * Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ deregisterElasticIp(input: AWS.OpsWorks.DeregisterElasticIpRequest, options: SdkCallOptions): Promise<{}>; /** * Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ deregisterInstance(input: AWS.OpsWorks.DeregisterInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Deregisters an Amazon RDS instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ deregisterRdsDbInstance(input: AWS.OpsWorks.DeregisterRdsDbInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ deregisterVolume(input: AWS.OpsWorks.DeregisterVolumeRequest, options: SdkCallOptions): Promise<{}>; /** * Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager. */ describeAgentVersions(input: AWS.OpsWorks.DescribeAgentVersionsRequest, options: SdkCallOptions): Promise; /** * Requests a description of a specified set of apps. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeApps(input: AWS.OpsWorks.DescribeAppsRequest, options: SdkCallOptions): Promise; /** * Describes the results of specified commands. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeCommands(input: AWS.OpsWorks.DescribeCommandsRequest, options: SdkCallOptions): Promise; /** * Requests a description of a specified set of deployments. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeDeployments(input: AWS.OpsWorks.DescribeDeploymentsRequest, options: SdkCallOptions): Promise; /** * Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. */ describeEcsClusters(input: AWS.OpsWorks.DescribeEcsClustersRequest, options: SdkCallOptions): Promise; /** * Describes Elastic IP addresses. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeElasticIps(input: AWS.OpsWorks.DescribeElasticIpsRequest, options: SdkCallOptions): Promise; /** * Describes a stack's Elastic Load Balancing instances. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeElasticLoadBalancers(input: AWS.OpsWorks.DescribeElasticLoadBalancersRequest, options: SdkCallOptions): Promise; /** * Requests a description of a set of instances. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeInstances(input: AWS.OpsWorks.DescribeInstancesRequest, options: SdkCallOptions): Promise; /** * Requests a description of one or more layers in a specified stack. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeLayers(input: AWS.OpsWorks.DescribeLayersRequest, options: SdkCallOptions): Promise; /** * Describes load-based auto scaling configurations for specified layers. You must specify at least one of the parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeLoadBasedAutoScaling(input: AWS.OpsWorks.DescribeLoadBasedAutoScalingRequest, options: SdkCallOptions): Promise; /** * Describes the permissions for a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ describePermissions(input: AWS.OpsWorks.DescribePermissionsRequest, options: SdkCallOptions): Promise; /** * Describe an instance's RAID arrays. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeRaidArrays(input: AWS.OpsWorks.DescribeRaidArraysRequest, options: SdkCallOptions): Promise; /** * Describes Amazon RDS instances. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. */ describeRdsDbInstances(input: AWS.OpsWorks.DescribeRdsDbInstancesRequest, options: SdkCallOptions): Promise; /** * Describes AWS OpsWorks Stacks service errors. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter. */ describeServiceErrors(input: AWS.OpsWorks.DescribeServiceErrorsRequest, options: SdkCallOptions): Promise; /** * Requests a description of a stack's provisioning parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeStackProvisioningParameters(input: AWS.OpsWorks.DescribeStackProvisioningParametersRequest, options: SdkCallOptions): Promise; /** * Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeStackSummary(input: AWS.OpsWorks.DescribeStackSummaryRequest, options: SdkCallOptions): Promise; /** * Requests a description of one or more stacks. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeStacks(input: AWS.OpsWorks.DescribeStacksRequest, options: SdkCallOptions): Promise; /** * Describes time-based auto scaling configurations for specified instances. You must specify at least one of the parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeTimeBasedAutoScaling(input: AWS.OpsWorks.DescribeTimeBasedAutoScalingRequest, options: SdkCallOptions): Promise; /** * Describe specified users. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeUserProfiles(input: AWS.OpsWorks.DescribeUserProfilesRequest, options: SdkCallOptions): Promise; /** * Describes an instance's Amazon EBS volumes. This call accepts only one resource-identifying parameter. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ describeVolumes(input: AWS.OpsWorks.DescribeVolumesRequest, options: SdkCallOptions): Promise; /** * Detaches a specified Elastic Load Balancing instance from its layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ detachElasticLoadBalancer(input: AWS.OpsWorks.DetachElasticLoadBalancerRequest, options: SdkCallOptions): Promise<{}>; /** * Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ disassociateElasticIp(input: AWS.OpsWorks.DisassociateElasticIpRequest, options: SdkCallOptions): Promise<{}>; /** * Gets a generated host name for the specified layer, based on the current host name theme. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ getHostnameSuggestion(input: AWS.OpsWorks.GetHostnameSuggestionRequest, options: SdkCallOptions): Promise; /** * This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period. */ grantAccess(input: AWS.OpsWorks.GrantAccessRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags that are applied to the specified stack or layer. */ listTags(input: AWS.OpsWorks.ListTagsRequest, options: SdkCallOptions): Promise; /** * Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ rebootInstance(input: AWS.OpsWorks.RebootInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ registerEcsCluster(input: AWS.OpsWorks.RegisterEcsClusterRequest, options: SdkCallOptions): Promise; /** * Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ registerElasticIp(input: AWS.OpsWorks.RegisterElasticIpRequest, options: SdkCallOptions): Promise; /** * Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack. We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack. Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ registerInstance(input: AWS.OpsWorks.RegisterInstanceRequest, options: SdkCallOptions): Promise; /** * Registers an Amazon RDS instance with a stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ registerRdsDbInstance(input: AWS.OpsWorks.RegisterRdsDbInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ registerVolume(input: AWS.OpsWorks.RegisterVolumeRequest, options: SdkCallOptions): Promise; /** * Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances. To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ setLoadBasedAutoScaling(input: AWS.OpsWorks.SetLoadBasedAutoScalingRequest, options: SdkCallOptions): Promise<{}>; /** * Specifies a user's permissions. For more information, see Security and Permissions. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ setPermission(input: AWS.OpsWorks.SetPermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ setTimeBasedAutoScaling(input: AWS.OpsWorks.SetTimeBasedAutoScalingRequest, options: SdkCallOptions): Promise<{}>; /** * Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ startInstance(input: AWS.OpsWorks.StartInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Starts a stack's instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ startStack(input: AWS.OpsWorks.StartStackRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ stopInstance(input: AWS.OpsWorks.StopInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ stopStack(input: AWS.OpsWorks.StopStackRequest, options: SdkCallOptions): Promise<{}>; /** * Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide. */ tagResource(input: AWS.OpsWorks.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ unassignInstance(input: AWS.OpsWorks.UnassignInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ unassignVolume(input: AWS.OpsWorks.UnassignVolumeRequest, options: SdkCallOptions): Promise<{}>; /** * Removes tags from a specified stack or layer. */ untagResource(input: AWS.OpsWorks.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a specified app. Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ updateApp(input: AWS.OpsWorks.UpdateAppRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a registered Elastic IP address's name. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ updateElasticIp(input: AWS.OpsWorks.UpdateElasticIpRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a specified instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ updateInstance(input: AWS.OpsWorks.UpdateInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a specified layer. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ updateLayer(input: AWS.OpsWorks.UpdateLayerRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a user's SSH public key. Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ updateMyUserProfile(input: AWS.OpsWorks.UpdateMyUserProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an Amazon RDS instance. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ updateRdsDbInstance(input: AWS.OpsWorks.UpdateRdsDbInstanceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a specified stack. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ updateStack(input: AWS.OpsWorks.UpdateStackRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a specified user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. */ updateUserProfile(input: AWS.OpsWorks.UpdateUserProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions. */ updateVolume(input: AWS.OpsWorks.UpdateVolumeRequest, options: SdkCallOptions): Promise<{}>; } export interface OpsWorksCM { /** * Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode. On a Chef server: This command is an alternative to knife bootstrap. Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem" On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR. Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem" A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance. */ associateNode(input: AWS.OpsWorksCM.AssociateNodeRequest, options: SdkCallOptions): Promise; /** * Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created. Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups. This operation is asynchronous. A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid. */ createBackup(input: AWS.OpsWorksCM.CreateBackupRequest, options: SdkCallOptions): Promise; /** * Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers. This operation is asynchronous. A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid. If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group. Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console. To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey. */ createServer(input: AWS.OpsWorksCM.CreateServerRequest, options: SdkCallOptions): Promise; /** * Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous. An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid. */ deleteBackup(input: AWS.OpsWorksCM.DeleteBackupRequest, options: SdkCallOptions): Promise; /** * Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted. This operation is asynchronous. An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. */ deleteServer(input: AWS.OpsWorksCM.DeleteServerRequest, options: SdkCallOptions): Promise; /** * Describes your OpsWorks-CM account attributes. This operation is synchronous. */ describeAccountAttributes(input: AWS.OpsWorksCM.DescribeAccountAttributesRequest, options: SdkCallOptions): Promise; /** * Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups. This operation is synchronous. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid. */ describeBackups(input: AWS.OpsWorksCM.DescribeBackupsRequest, options: SdkCallOptions): Promise; /** * Describes events for a specified server. Results are ordered by time, with newest events first. This operation is synchronous. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. */ describeEvents(input: AWS.OpsWorksCM.DescribeEventsRequest, options: SdkCallOptions): Promise; /** * Returns the current status of an existing association or disassociation request. A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid. */ describeNodeAssociationStatus(input: AWS.OpsWorksCM.DescribeNodeAssociationStatusRequest, options: SdkCallOptions): Promise; /** * Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services. This operation is synchronous. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. */ describeServers(input: AWS.OpsWorksCM.DescribeServersRequest, options: SdkCallOptions): Promise; /** * Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode. A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. */ disassociateNode(input: AWS.OpsWorksCM.DisassociateNodeRequest, options: SdkCallOptions): Promise; /** * Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server. This operation is synchronous. A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING. */ exportServerEngineAttribute(input: AWS.OpsWorksCM.ExportServerEngineAttributeRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups. */ listTagsForResource(input: AWS.OpsWorksCM.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work. Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated. This operation is asynchronous. An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. */ restoreServer(input: AWS.OpsWorksCM.RestoreServerRequest, options: SdkCallOptions): Promise; /** * Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress. Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. */ startMaintenance(input: AWS.OpsWorksCM.StartMaintenanceRequest, options: SdkCallOptions): Promise; /** * Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups. */ tagResource(input: AWS.OpsWorksCM.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes specified tags from an AWS OpsWorks-CM server or backup. */ untagResource(input: AWS.OpsWorksCM.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates settings for a server. This operation is synchronous. */ updateServer(input: AWS.OpsWorksCM.UpdateServerRequest, options: SdkCallOptions): Promise; /** * Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD). This operation is asynchronous. This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. */ updateServerEngineAttributes(input: AWS.OpsWorksCM.UpdateServerEngineAttributesRequest, options: SdkCallOptions): Promise; } export interface Organizations { /** * Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request. This operation can be called only by the following principals when they also have the relevant IAM permissions: Invitation to join or Approve all features request handshakes: only a principal from the member account. The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, the user must also have the iam:CreateServiceLinkedRole permission so that Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and Service-Linked Roles in the Organizations User Guide. Enable all features final confirmation handshake: only a principal from the management account. For more information about invitations, see Inviting an Amazon Web Services account to join your organization in the Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling all features in your organization in the Organizations User Guide. After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted. */ acceptHandshake(input: AWS.Organizations.AcceptHandshakeRequest, options: SdkCallOptions): Promise; /** * Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the Organizations User Guide for information about each policy type: AISERVICES_OPT_OUT_POLICY BACKUP_POLICY SERVICE_CONTROL_POLICY TAG_POLICY This operation can be called only from the organization's management account. */ attachPolicy(input: AWS.Organizations.AttachPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED. This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake. After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted. */ cancelHandshake(input: AWS.Organizations.CancelHandshakeRequest, options: SdkCallOptions): Promise; /** * Closes an Amazon Web Services member account within an organization. You can't close the management account with this API. This is an asynchronous request that Amazon Web Services performs in the background. Because CloseAccount operates asynchronously, it can return a successful completion message even though account closure might still be in progress. You need to wait a few minutes before the account is fully closed. To check the status of the request, do one of the following: Use the AccountId that you sent in the CloseAccount request to provide as a parameter to the DescribeAccount operation. While the close account request is in progress, Account status will indicate PENDING_CLOSURE. When the close account request completes, the status will change to SUSPENDED. Check the CloudTrail log for the CloseAccountResult event that gets published after the account closes successfully. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide. You can only close 10% of active member accounts within a rolling 30 day period. This quota is not bound by a calendar month, but starts when you close an account. Within 30 days of that initial account closure, you can't exceed the 10% account closure limit. To reinstate a closed account, contact Amazon Web Services Support within the 90-day grace period while the account is in SUSPENDED status. If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud (US) account, the CloseAccount request will close both accounts. To learn important pre-closure details, see Closing an Amazon Web Services GovCloud (US) account in the Amazon Web Services GovCloud User Guide. For more information about closing accounts, see Closing an Amazon Web Services account in the Organizations User Guide. */ closeAccount(input: AWS.Organizations.CloseAccountRequest, options: SdkCallOptions): Promise<{}>; /** * Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the Id member of the CreateAccountStatus response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide. The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and Service-Linked Roles in the Organizations User Guide. If the request includes tags, then the requester must have the organizations:TagResource permission. Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. Organizations clones the company name and address information for the new account from the organization's management account. This operation can be called only from the organization's management account. For more information about creating accounts, see Creating an Amazon Web Services account in Your Organization in the Organizations User Guide. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support. Using CreateAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an Amazon Web Services account in the Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools. */ createAccount(input: AWS.Organizations.CreateAccountRequest, options: SdkCallOptions): Promise; /** * This action is available if all of the following are true: You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For more information on the Amazon Web Services GovCloud (US) Region, see the Amazon Web Services GovCloud User Guide. You already have an account in the Amazon Web Services GovCloud (US) Region that is paired with a management account of an organization in the commercial Region. You call this action from the management account of your organization in the commercial Region. You have the organizations:CreateGovCloudAccount permission. Organizations automatically creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and Service-Linked Roles in the Organizations User Guide. Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also do the following: Verify that CloudTrail is enabled to store logs. Create an Amazon S3 bucket for CloudTrail log storage. For more information, see Verifying CloudTrail Is Enabled in the Amazon Web Services GovCloud User Guide. If the request includes tags, then the requester must have the organizations:TagResource permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud account exists. You call this action from the management account of your organization in the commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US) Region. After the account is created, the management account of an organization in the Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see Organizations in the Amazon Web Services GovCloud User Guide. Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following: Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation. Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the Organizations User Guide. When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address. A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see Organizations in the Amazon Web Services GovCloud User Guide. For more information about creating accounts, see Creating an Amazon Web Services account in Your Organization in the Organizations User Guide. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is not automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the Organizations User Guide. If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support. If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support. Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an Amazon Web Services account in the Organizations User Guide. When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools. */ createGovCloudAccount(input: AWS.Organizations.CreateGovCloudAccountRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Web Services organization. The account whose user is calling the CreateOrganization operation automatically becomes the management account of the new organization. This operation must be called using credentials from the account that is to become the new organization's management account. The principal must also have the relevant IAM permissions. By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING", no policy types are enabled by default, and you can't use organization policies */ createOrganization(input: AWS.Organizations.CreateOrganizationRequest, options: SdkCallOptions): Promise; /** * Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five. For more information about OUs, see Managing Organizational Units in the Organizations User Guide. If the request includes tags, then the requester must have the organizations:TagResource permission. This operation can be called only from the organization's management account. */ createOrganizationalUnit(input: AWS.Organizations.CreateOrganizationalUnitRequest, options: SdkCallOptions): Promise; /** * Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account. For more information about policies and their use, see Managing Organization Policies. If the request includes tags, then the requester must have the organizations:TagResource permission. This operation can be called only from the organization's management account. */ createPolicy(input: AWS.Organizations.CreatePolicyRequest, options: SdkCallOptions): Promise; /** * Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request. This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request. After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted. */ declineHandshake(input: AWS.Organizations.DeclineHandshakeRequest, options: SdkCallOptions): Promise; /** * Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete. This operation can be called only from the organization's management account. */ deleteOrganizationalUnit(input: AWS.Organizations.DeleteOrganizationalUnitRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts. This operation can be called only from the organization's management account. */ deletePolicy(input: AWS.Organizations.DeletePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service. Deregistering a delegated administrator can have unintended impacts on the functionality of the enabled Amazon Web Services service. See the documentation for the enabled service before you deregister a delegated administrator so that you understand any potential impacts. You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at Amazon Web Services Services that you can use with Organizations in the Organizations User Guide. This operation can be called only from the organization's management account. */ deregisterDelegatedAdministrator(input: AWS.Organizations.DeregisterDelegatedAdministratorRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves Organizations-related information about the specified account. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ describeAccount(input: AWS.Organizations.DescribeAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves the current status of an asynchronous request to create an account. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ describeCreateAccountStatus(input: AWS.Organizations.DescribeCreateAccountStatusRequest, options: SdkCallOptions): Promise; /** * Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account. This operation applies only to policy types other than service control policies (SCPs). For more information about policy inheritance, see How Policy Inheritance Works in the Organizations User Guide. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ describeEffectivePolicy(input: AWS.Organizations.DescribeEffectivePolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake. You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They're then deleted and no longer accessible. This operation can be called from any account in the organization. */ describeHandshake(input: AWS.Organizations.DescribeHandshakeRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an organizational unit (OU). This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ describeOrganizationalUnit(input: AWS.Organizations.DescribeOrganizationalUnitRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a policy. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ describePolicy(input: AWS.Organizations.DescribePolicyRequest, options: SdkCallOptions): Promise; /** * Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for Identity and Access Management (IAM) users and roles in affected accounts are immediate. Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an "allow list". If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of a "deny list". This operation can be called only from the organization's management account. */ detachPolicy(input: AWS.Organizations.DetachPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Disables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from Organizations. We strongly recommend that you don't use this command to disable integration between Organizations and the specified Amazon Web Services service. Instead, use the console or commands that are provided by the specified service. This lets the trusted service perform any required initialization when enabling trusted access, such as creating any required resources and any required clean up of resources when disabling trusted access. For information about how to disable trusted service access to your organization using the trusted service, see the Learn more link under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations. on this page. If you disable access by using this command, it causes the following actions to occur: The service can no longer create a service-linked role in the accounts in your organization. This means that the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from Organizations. The service can no longer perform tasks in the member accounts in the organization, unless those operations are explicitly permitted by the IAM policies that are attached to your roles. This includes any data aggregation from the member accounts to the management account, or to a delegated administrator account, where relevant. Some services detect this and clean up any remaining data or resources related to the integration, while other services stop accessing the organization but leave any historical data and configuration in place to support a possible re-enabling of the integration. Using the other service's console or commands to disable the integration ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service. After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts For more information about integrating other services with Organizations, including the list of services that work with Organizations, see Integrating Organizations with Other Amazon Web Services Services in the Organizations User Guide. This operation can be called only from the organization's management account. */ disableAWSServiceAccess(input: AWS.Organizations.DisableAWSServiceAccessRequest, options: SdkCallOptions): Promise<{}>; /** * Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation. This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation. This operation can be called only from the organization's management account. To view the status of available policy types in the organization, use DescribeOrganization. */ disablePolicyType(input: AWS.Organizations.DisablePolicyTypeRequest, options: SdkCallOptions): Promise; /** * Enables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts. We recommend that you enable integration between Organizations and the specified Amazon Web Services service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service. For more information about enabling services to integrate with Organizations, see Integrating Organizations with Other Amazon Web Services Services in the Organizations User Guide. This operation can be called only from the organization's management account and only if the organization has enabled all features. */ enableAWSServiceAccess(input: AWS.Organizations.EnableAWSServiceAccessRequest, options: SdkCallOptions): Promise<{}>; /** * Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that Organizations supports. For more information, see Enabling All Features in Your Organization in the Organizations User Guide. This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake. After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots. After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains "Action": "ENABLE_ALL_FEATURES". This completes the change. After you enable all features in your organization, the management account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The management account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this. This operation can be called only from the organization's management account. */ enableAllFeatures(input: AWS.Organizations.EnableAllFeaturesRequest, options: SdkCallOptions): Promise; /** * Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation. This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation. This operation can be called only from the organization's management account. You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use DescribeOrganization. */ enablePolicyType(input: AWS.Organizations.EnablePolicyTypeRequest, options: SdkCallOptions): Promise; /** * Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response. You can invite Amazon Web Services accounts only from the same seller as the management account. For example, if your organization's management account was created by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you can invite only other AISPL accounts to your organization. You can't combine accounts from AISPL and Amazon Web Services or from any other Amazon Web Services seller. For more information, see Consolidated Billing in India. If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, contact Amazon Web Services Support. If the request includes tags, then the requester must have the organizations:TagResource permission. This operation can be called only from the organization's management account. */ inviteAccountToOrganization(input: AWS.Organizations.InviteAccountToOrganizationRequest, options: SdkCallOptions): Promise; /** * Returns a list of the Amazon Web Services services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts. For more information about integrating other services with Organizations, including the list of services that currently work with Organizations, see Integrating Organizations with Other Amazon Web Services Services in the Organizations User Guide. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listAWSServiceAccessForOrganization(input: AWS.Organizations.ListAWSServiceAccessForOrganizationRequest, options: SdkCallOptions): Promise; /** * Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listAccounts(input: AWS.Organizations.ListAccountsRequest, options: SdkCallOptions): Promise; /** * Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listAccountsForParent(input: AWS.Organizations.ListAccountsForParentRequest, options: SdkCallOptions): Promise; /** * Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listChildren(input: AWS.Organizations.ListChildrenRequest, options: SdkCallOptions): Promise; /** * Lists the account creation requests that match the specified status that is currently being tracked for the organization. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listCreateAccountStatus(input: AWS.Organizations.ListCreateAccountStatusRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listDelegatedAdministrators(input: AWS.Organizations.ListDelegatedAdministratorsRequest, options: SdkCallOptions): Promise; /** * List the Amazon Web Services services for which the specified account is a delegated administrator. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listDelegatedServicesForAccount(input: AWS.Organizations.ListDelegatedServicesForAccountRequest, options: SdkCallOptions): Promise; /** * Lists the current handshakes that are associated with the account of the requesting user. Handshakes that are ACCEPTED, DECLINED, CANCELED, or EXPIRED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called from any account in the organization. */ listHandshakesForAccount(input: AWS.Organizations.ListHandshakesForAccountRequest, options: SdkCallOptions): Promise; /** * Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake. Handshakes that are ACCEPTED, DECLINED, CANCELED, or EXPIRED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listHandshakesForOrganization(input: AWS.Organizations.ListHandshakesForOrganizationRequest, options: SdkCallOptions): Promise; /** * Lists the organizational units (OUs) in a parent organizational unit or root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listOrganizationalUnitsForParent(input: AWS.Organizations.ListOrganizationalUnitsForParentRequest, options: SdkCallOptions): Promise; /** * Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. In the current release, a child can have only a single parent. */ listParents(input: AWS.Organizations.ListParentsRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of all policies in an organization of a specified type. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listPolicies(input: AWS.Organizations.ListPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listPoliciesForTarget(input: AWS.Organizations.ListPoliciesForTargetRequest, options: SdkCallOptions): Promise; /** * Lists the roots that are defined in the current organization. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization. */ listRoots(input: AWS.Organizations.ListRootsRequest, options: SdkCallOptions): Promise; /** * Lists tags that are attached to the specified resource. You can attach tags to the following resources in Organizations. Amazon Web Services account Organization root Organizational unit (OU) Policy (any type) This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listTagsForResource(input: AWS.Organizations.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to. Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service. */ listTargetsForPolicy(input: AWS.Organizations.ListTargetsForPolicyRequest, options: SdkCallOptions): Promise; /** * Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU. This operation can be called only from the organization's management account. */ moveAccount(input: AWS.Organizations.MoveAccountRequest, options: SdkCallOptions): Promise<{}>; /** * Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to Organizations service data. The account still requires IAM permissions to access and administer the Amazon Web Services service. You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at Amazon Web Services Services that you can use with Organizations in the Organizations User Guide. This operation can be called only from the organization's management account. */ registerDelegatedAdministrator(input: AWS.Organizations.RegisterDelegatedAdministratorRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the specified account from the organization. The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's management account is no longer charged for any expenses accrued by the member account after it's removed from the organization. This operation can be called only from the organization's management account. Member accounts can remove themselves with LeaveOrganization instead. You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must choose a support plan, provide and verify the required contact information, and provide a current payment method. Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn't attached to an organization. To remove an account that doesn't yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the Organizations User Guide. The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization. After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags. */ removeAccountFromOrganization(input: AWS.Organizations.RemoveAccountFromOrganizationRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more tags to the specified resource. Currently, you can attach tags to the following resources in Organizations. Amazon Web Services account Organization root Organizational unit (OU) Policy (any type) This operation can be called only from the organization's management account. */ tagResource(input: AWS.Organizations.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes any tags with the specified keys from the specified resource. You can attach tags to the following resources in Organizations. Amazon Web Services account Organization root Organizational unit (OU) Policy (any type) This operation can be called only from the organization's management account. */ untagResource(input: AWS.Organizations.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached. This operation can be called only from the organization's management account. */ updateOrganizationalUnit(input: AWS.Organizations.UpdateOrganizationalUnitRequest, options: SdkCallOptions): Promise; /** * Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type. This operation can be called only from the organization's management account. */ updatePolicy(input: AWS.Organizations.UpdatePolicyRequest, options: SdkCallOptions): Promise; } export interface Outposts { /** * Cancels the specified order for an Outpost. */ cancelOrder(input: AWS.Outposts.CancelOrderInput, options: SdkCallOptions): Promise; /** * Creates an order for an Outpost. */ createOrder(input: AWS.Outposts.CreateOrderInput, options: SdkCallOptions): Promise; /** * Creates an Outpost. You can specify either an Availability one or an AZ ID. */ createOutpost(input: AWS.Outposts.CreateOutpostInput, options: SdkCallOptions): Promise; /** * Creates a site for an Outpost. */ createSite(input: AWS.Outposts.CreateSiteInput, options: SdkCallOptions): Promise; /** * Deletes the specified Outpost. */ deleteOutpost(input: AWS.Outposts.DeleteOutpostInput, options: SdkCallOptions): Promise; /** * Deletes the specified site. */ deleteSite(input: AWS.Outposts.DeleteSiteInput, options: SdkCallOptions): Promise; /** * Gets information about the specified catalog item. */ getCatalogItem(input: AWS.Outposts.GetCatalogItemInput, options: SdkCallOptions): Promise; /** * Amazon Web Services uses this action to install Outpost servers. Gets information about the specified connection. Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide. */ getConnection(input: AWS.Outposts.GetConnectionRequest, options: SdkCallOptions): Promise; /** * Gets information about the specified order. */ getOrder(input: AWS.Outposts.GetOrderInput, options: SdkCallOptions): Promise; /** * Gets information about the specified Outpost. */ getOutpost(input: AWS.Outposts.GetOutpostInput, options: SdkCallOptions): Promise; /** * Gets the instance types for the specified Outpost. */ getOutpostInstanceTypes(input: AWS.Outposts.GetOutpostInstanceTypesInput, options: SdkCallOptions): Promise; /** * Gets information about the specified Outpost site. */ getSite(input: AWS.Outposts.GetSiteInput, options: SdkCallOptions): Promise; /** * Gets the site address of the specified site. */ getSiteAddress(input: AWS.Outposts.GetSiteAddressInput, options: SdkCallOptions): Promise; /** * Lists the hardware assets for the specified Outpost. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter. */ listAssets(input: AWS.Outposts.ListAssetsInput, options: SdkCallOptions): Promise; /** * Lists the items in the catalog. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter. */ listCatalogItems(input: AWS.Outposts.ListCatalogItemsInput, options: SdkCallOptions): Promise; /** * Lists the Outpost orders for your Amazon Web Services account. */ listOrders(input: AWS.Outposts.ListOrdersInput, options: SdkCallOptions): Promise; /** * Lists the Outposts for your Amazon Web Services account. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter. */ listOutposts(input: AWS.Outposts.ListOutpostsInput, options: SdkCallOptions): Promise; /** * Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter. */ listSites(input: AWS.Outposts.ListSitesInput, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.Outposts.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Amazon Web Services uses this action to install Outpost servers. Starts the connection required for Outpost server installation. Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide. */ startConnection(input: AWS.Outposts.StartConnectionRequest, options: SdkCallOptions): Promise; /** * Adds tags to the specified resource. */ tagResource(input: AWS.Outposts.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from the specified resource. */ untagResource(input: AWS.Outposts.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an Outpost. */ updateOutpost(input: AWS.Outposts.UpdateOutpostInput, options: SdkCallOptions): Promise; /** * Updates the specified site. */ updateSite(input: AWS.Outposts.UpdateSiteInput, options: SdkCallOptions): Promise; /** * Updates the address of the specified site. You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order. You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated. */ updateSiteAddress(input: AWS.Outposts.UpdateSiteAddressInput, options: SdkCallOptions): Promise; /** * Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide. To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order. */ updateSiteRackPhysicalProperties(input: AWS.Outposts.UpdateSiteRackPhysicalPropertiesInput, options: SdkCallOptions): Promise; } export interface Panorama { /** * Creates an application instance and deploys it to a device. */ createApplicationInstance(input: AWS.Panorama.CreateApplicationInstanceRequest, options: SdkCallOptions): Promise; /** * Creates a job to run on one or more devices. */ createJobForDevices(input: AWS.Panorama.CreateJobForDevicesRequest, options: SdkCallOptions): Promise; /** * Creates a camera stream node. */ createNodeFromTemplateJob(input: AWS.Panorama.CreateNodeFromTemplateJobRequest, options: SdkCallOptions): Promise; /** * Creates a package and storage location in an Amazon S3 access point. */ createPackage(input: AWS.Panorama.CreatePackageRequest, options: SdkCallOptions): Promise; /** * Imports a node package. */ createPackageImportJob(input: AWS.Panorama.CreatePackageImportJobRequest, options: SdkCallOptions): Promise; /** * Deletes a device. */ deleteDevice(input: AWS.Panorama.DeleteDeviceRequest, options: SdkCallOptions): Promise; /** * Deletes a package. To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API. */ deletePackage(input: AWS.Panorama.DeletePackageRequest, options: SdkCallOptions): Promise; /** * Deregisters a package version. */ deregisterPackageVersion(input: AWS.Panorama.DeregisterPackageVersionRequest, options: SdkCallOptions): Promise; /** * Returns information about an application instance on a device. */ describeApplicationInstance(input: AWS.Panorama.DescribeApplicationInstanceRequest, options: SdkCallOptions): Promise; /** * Returns information about an application instance's configuration manifest. */ describeApplicationInstanceDetails(input: AWS.Panorama.DescribeApplicationInstanceDetailsRequest, options: SdkCallOptions): Promise; /** * Returns information about a device. */ describeDevice(input: AWS.Panorama.DescribeDeviceRequest, options: SdkCallOptions): Promise; /** * Returns information about a device job. */ describeDeviceJob(input: AWS.Panorama.DescribeDeviceJobRequest, options: SdkCallOptions): Promise; /** * Returns information about a node. */ describeNode(input: AWS.Panorama.DescribeNodeRequest, options: SdkCallOptions): Promise; /** * Returns information about a job to create a camera stream node. */ describeNodeFromTemplateJob(input: AWS.Panorama.DescribeNodeFromTemplateJobRequest, options: SdkCallOptions): Promise; /** * Returns information about a package. */ describePackage(input: AWS.Panorama.DescribePackageRequest, options: SdkCallOptions): Promise; /** * Returns information about a package import job. */ describePackageImportJob(input: AWS.Panorama.DescribePackageImportJobRequest, options: SdkCallOptions): Promise; /** * Returns information about a package version. */ describePackageVersion(input: AWS.Panorama.DescribePackageVersionRequest, options: SdkCallOptions): Promise; /** * Returns a list of application instance dependencies. */ listApplicationInstanceDependencies(input: AWS.Panorama.ListApplicationInstanceDependenciesRequest, options: SdkCallOptions): Promise; /** * Returns a list of application node instances. */ listApplicationInstanceNodeInstances(input: AWS.Panorama.ListApplicationInstanceNodeInstancesRequest, options: SdkCallOptions): Promise; /** * Returns a list of application instances. */ listApplicationInstances(input: AWS.Panorama.ListApplicationInstancesRequest, options: SdkCallOptions): Promise; /** * Returns a list of devices. */ listDevices(input: AWS.Panorama.ListDevicesRequest, options: SdkCallOptions): Promise; /** * Returns a list of jobs. */ listDevicesJobs(input: AWS.Panorama.ListDevicesJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of camera stream node jobs. */ listNodeFromTemplateJobs(input: AWS.Panorama.ListNodeFromTemplateJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of nodes. */ listNodes(input: AWS.Panorama.ListNodesRequest, options: SdkCallOptions): Promise; /** * Returns a list of package import jobs. */ listPackageImportJobs(input: AWS.Panorama.ListPackageImportJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of packages. */ listPackages(input: AWS.Panorama.ListPackagesRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags for a resource. */ listTagsForResource(input: AWS.Panorama.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output. */ provisionDevice(input: AWS.Panorama.ProvisionDeviceRequest, options: SdkCallOptions): Promise; /** * Registers a package version. */ registerPackageVersion(input: AWS.Panorama.RegisterPackageVersionRequest, options: SdkCallOptions): Promise; /** * Removes an application instance. */ removeApplicationInstance(input: AWS.Panorama.RemoveApplicationInstanceRequest, options: SdkCallOptions): Promise; /** * Tags a resource. */ tagResource(input: AWS.Panorama.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource. */ untagResource(input: AWS.Panorama.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a device's metadata. */ updateDeviceMetadata(input: AWS.Panorama.UpdateDeviceMetadataRequest, options: SdkCallOptions): Promise; } export interface Personalize { /** * Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Creating a batch inference job. */ createBatchInferenceJob(input: AWS.Personalize.CreateBatchInferenceJobRequest, options: SdkCallOptions): Promise; /** * Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments. */ createBatchSegmentJob(input: AWS.Personalize.CreateBatchSegmentJobRequest, options: SdkCallOptions): Promise; /** * Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions. The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary. Status A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the campaign status, call DescribeCampaign. Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign */ createCampaign(input: AWS.Personalize.CreateCampaignRequest, options: SdkCallOptions): Promise; /** * Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are three types of datasets: Interactions Items Users Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution). A dataset can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset */ createDataset(input: AWS.Personalize.CreateDatasetRequest, options: SdkCallOptions): Promise; /** * Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. */ createDatasetExportJob(input: AWS.Personalize.CreateDatasetExportJobRequest, options: SdkCallOptions): Promise; /** * Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup */ createDatasetGroup(input: AWS.Personalize.CreateDatasetGroupRequest, options: SdkCallOptions): Promise; /** * Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation. Status A dataset import job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob */ createDatasetImportJob(input: AWS.Personalize.CreateDatasetImportJobRequest, options: SdkCallOptions): Promise; /** * Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker */ createEventTracker(input: AWS.Personalize.CreateEventTrackerRequest, options: SdkCallOptions): Promise; /** * Creates a recommendation filter. For more information, see Filtering recommendations and user segments. */ createFilter(input: AWS.Personalize.CreateFilterRequest, options: SdkCallOptions): Promise; /** * Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request. Minimum recommendation requests per second When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage. If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There's a short time delay while the capacity is increased that might cause loss of requests. Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary. Status A recommender can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE DELETE PENDING > DELETE IN_PROGRESS To get the recommender status, call DescribeRecommender. Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations. Related APIs ListRecommenders DescribeRecommender UpdateRecommender DeleteRecommender */ createRecommender(input: AWS.Personalize.CreateRecommenderRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema */ createSchema(input: AWS.Personalize.CreateSchemaRequest, options: SdkCallOptions): Promise; /** * Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created. After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you. Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time. Status A solution can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion */ createSolution(input: AWS.Personalize.CreateSolutionRequest, options: SdkCallOptions): Promise; /** * Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation. Status A solution version can be in one of the following states: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED CREATE STOPPING CREATE STOPPED To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListSolutionVersions DescribeSolutionVersion ListSolutions CreateSolution DescribeSolution DeleteSolution */ createSolutionVersion(input: AWS.Personalize.CreateSolutionVersionRequest, options: SdkCallOptions): Promise; /** * Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign. */ deleteCampaign(input: AWS.Personalize.DeleteCampaignRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset. */ deleteDataset(input: AWS.Personalize.DeleteDatasetRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group. */ deleteDatasetGroup(input: AWS.Personalize.DeleteDatasetGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker. */ deleteEventTracker(input: AWS.Personalize.DeleteEventTrackerRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a filter. */ deleteFilter(input: AWS.Personalize.DeleteFilterRequest, options: SdkCallOptions): Promise<{}>; /** * Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request. */ deleteRecommender(input: AWS.Personalize.DeleteRecommenderRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema. */ deleteSchema(input: AWS.Personalize.DeleteSchemaRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution. */ deleteSolution(input: AWS.Personalize.DeleteSolutionRequest, options: SdkCallOptions): Promise<{}>; /** * Describes the given algorithm. */ describeAlgorithm(input: AWS.Personalize.DescribeAlgorithmRequest, options: SdkCallOptions): Promise; /** * Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations. */ describeBatchInferenceJob(input: AWS.Personalize.DescribeBatchInferenceJobRequest, options: SdkCallOptions): Promise; /** * Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments. */ describeBatchSegmentJob(input: AWS.Personalize.DescribeBatchSegmentJobRequest, options: SdkCallOptions): Promise; /** * Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign. */ describeCampaign(input: AWS.Personalize.DescribeCampaignRequest, options: SdkCallOptions): Promise; /** * Describes the given dataset. For more information on datasets, see CreateDataset. */ describeDataset(input: AWS.Personalize.DescribeDatasetRequest, options: SdkCallOptions): Promise; /** * Describes the dataset export job created by CreateDatasetExportJob, including the export job status. */ describeDatasetExportJob(input: AWS.Personalize.DescribeDatasetExportJobRequest, options: SdkCallOptions): Promise; /** * Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup. */ describeDatasetGroup(input: AWS.Personalize.DescribeDatasetGroupRequest, options: SdkCallOptions): Promise; /** * Describes the dataset import job created by CreateDatasetImportJob, including the import job status. */ describeDatasetImportJob(input: AWS.Personalize.DescribeDatasetImportJobRequest, options: SdkCallOptions): Promise; /** * Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker. */ describeEventTracker(input: AWS.Personalize.DescribeEventTrackerRequest, options: SdkCallOptions): Promise; /** * Describes the given feature transformation. */ describeFeatureTransformation(input: AWS.Personalize.DescribeFeatureTransformationRequest, options: SdkCallOptions): Promise; /** * Describes a filter's properties. */ describeFilter(input: AWS.Personalize.DescribeFilterRequest, options: SdkCallOptions): Promise; /** * Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API. */ describeRecipe(input: AWS.Personalize.DescribeRecipeRequest, options: SdkCallOptions): Promise; /** * Describes the given recommender, including its status. A recommender can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE DELETE PENDING > DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. The modelMetrics key is null when the recommender is being created or deleted. For more information on recommenders, see CreateRecommender. */ describeRecommender(input: AWS.Personalize.DescribeRecommenderRequest, options: SdkCallOptions): Promise; /** * Describes a schema. For more information on schemas, see CreateSchema. */ describeSchema(input: AWS.Personalize.DescribeSchemaRequest, options: SdkCallOptions): Promise; /** * Describes a solution. For more information on solutions, see CreateSolution. */ describeSolution(input: AWS.Personalize.DescribeSolutionRequest, options: SdkCallOptions): Promise; /** * Describes a specific version of a solution. For more information on solutions, see CreateSolution */ describeSolutionVersion(input: AWS.Personalize.DescribeSolutionVersionRequest, options: SdkCallOptions): Promise; /** * Gets the metrics for the specified solution version. */ getSolutionMetrics(input: AWS.Personalize.GetSolutionMetricsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the batch inference jobs that have been performed off of a solution version. */ listBatchInferenceJobs(input: AWS.Personalize.ListBatchInferenceJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the batch segment jobs that have been performed off of a solution version that you specify. */ listBatchSegmentJobs(input: AWS.Personalize.ListBatchSegmentJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign. */ listCampaigns(input: AWS.Personalize.ListCampaignsRequest, options: SdkCallOptions): Promise; /** * Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset. */ listDatasetExportJobs(input: AWS.Personalize.ListDatasetExportJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup. */ listDatasetGroups(input: AWS.Personalize.ListDatasetGroupsRequest, options: SdkCallOptions): Promise; /** * Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset. */ listDatasetImportJobs(input: AWS.Personalize.ListDatasetImportJobsRequest, options: SdkCallOptions): Promise; /** * Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset. */ listDatasets(input: AWS.Personalize.ListDatasetsRequest, options: SdkCallOptions): Promise; /** * Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker. */ listEventTrackers(input: AWS.Personalize.ListEventTrackersRequest, options: SdkCallOptions): Promise; /** * Lists all filters that belong to a given dataset group. */ listFilters(input: AWS.Personalize.ListFiltersRequest, options: SdkCallOptions): Promise; /** * Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN). */ listRecipes(input: AWS.Personalize.ListRecipesRequest, options: SdkCallOptions): Promise; /** * Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender. */ listRecommenders(input: AWS.Personalize.ListRecommendersRequest, options: SdkCallOptions): Promise; /** * Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema. */ listSchemas(input: AWS.Personalize.ListSchemasRequest, options: SdkCallOptions): Promise; /** * Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). */ listSolutionVersions(input: AWS.Personalize.ListSolutionVersionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution. */ listSolutions(input: AWS.Personalize.ListSolutionsRequest, options: SdkCallOptions): Promise; /** * Get a list of tags attached to a resource. */ listTagsForResource(input: AWS.Personalize.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender. */ startRecommender(input: AWS.Personalize.StartRecommenderRequest, options: SdkCallOptions): Promise; /** * Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender. */ stopRecommender(input: AWS.Personalize.StopRecommenderRequest, options: SdkCallOptions): Promise; /** * Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. Depending on the current state of the solution version, the solution version state changes as follows: CREATE_PENDING > CREATE_STOPPED or CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped. */ stopSolutionVersionCreation(input: AWS.Personalize.StopSolutionVersionCreationRequest, options: SdkCallOptions): Promise<{}>; /** * Add a list of tags to a resource. */ tagResource(input: AWS.Personalize.TagResourceRequest, options: SdkCallOptions): Promise; /** * Remove tags that are attached to a resource. */ untagResource(input: AWS.Personalize.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation. You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active. For more information on campaigns, see CreateCampaign. */ updateCampaign(input: AWS.Personalize.UpdateCampaignRequest, options: SdkCallOptions): Promise; /** * Updates the recommender to modify the recommender configuration. */ updateRecommender(input: AWS.Personalize.UpdateRecommenderRequest, options: SdkCallOptions): Promise; } export interface PersonalizeEvents { /** * Records user interaction event data. For more information see Recording Events. */ putEvents(input: AWS.PersonalizeEvents.PutEventsRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more items to an Items dataset. For more information see Importing Items Incrementally. */ putItems(input: AWS.PersonalizeEvents.PutItemsRequest, options: SdkCallOptions): Promise<{}>; /** * Adds one or more users to a Users dataset. For more information see Importing Users Incrementally. */ putUsers(input: AWS.PersonalizeEvents.PutUsersRequest, options: SdkCallOptions): Promise<{}>; } export interface PersonalizeRuntime { /** * Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user. The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING. */ getPersonalizedRanking(input: AWS.PersonalizeRuntime.GetPersonalizedRankingRequest, options: SdkCallOptions): Promise; /** * Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows: USER_PERSONALIZATION - userId required, itemId not used RELATED_ITEMS - itemId required, userId not used Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API. For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see Choosing recommender use cases. */ getRecommendations(input: AWS.PersonalizeRuntime.GetRecommendationsRequest, options: SdkCallOptions): Promise; } export interface PI { /** * For a specific time period, retrieve the top N dimension keys for a metric. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. */ describeDimensionKeys(input: AWS.PI.DescribeDimensionKeysRequest, options: SdkCallOptions): Promise; /** * Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text. */ getDimensionKeyDetails(input: AWS.PI.GetDimensionKeyDetailsRequest, options: SdkCallOptions): Promise; /** * Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance. */ getResourceMetadata(input: AWS.PI.GetResourceMetadataRequest, options: SdkCallOptions): Promise; /** * Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. */ getResourceMetrics(input: AWS.PI.GetResourceMetricsRequest, options: SdkCallOptions): Promise; /** * Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance. */ listAvailableResourceDimensions(input: AWS.PI.ListAvailableResourceDimensionsRequest, options: SdkCallOptions): Promise; /** * Retrieve metrics of the specified types that can be queried for a specified DB instance. */ listAvailableResourceMetrics(input: AWS.PI.ListAvailableResourceMetricsRequest, options: SdkCallOptions): Promise; } export interface Pinpoint { /** * Creates an application. */ createApp(input: AWS.Pinpoint.CreateAppRequest, options: SdkCallOptions): Promise; /** * Creates a new campaign for an application or updates the settings of an existing campaign for an application. */ createCampaign(input: AWS.Pinpoint.CreateCampaignRequest, options: SdkCallOptions): Promise; /** * Creates a message template for messages that are sent through the email channel. */ createEmailTemplate(input: AWS.Pinpoint.CreateEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Creates an export job for an application. */ createExportJob(input: AWS.Pinpoint.CreateExportJobRequest, options: SdkCallOptions): Promise; /** * Creates an import job for an application. */ createImportJob(input: AWS.Pinpoint.CreateImportJobRequest, options: SdkCallOptions): Promise; /** * Creates a new message template for messages using the in-app message channel. */ createInAppTemplate(input: AWS.Pinpoint.CreateInAppTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a journey for an application. */ createJourney(input: AWS.Pinpoint.CreateJourneyRequest, options: SdkCallOptions): Promise; /** * Creates a message template for messages that are sent through a push notification channel. */ createPushTemplate(input: AWS.Pinpoint.CreatePushTemplateRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Pinpoint configuration for a recommender model. */ createRecommenderConfiguration(input: AWS.Pinpoint.CreateRecommenderConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. */ createSegment(input: AWS.Pinpoint.CreateSegmentRequest, options: SdkCallOptions): Promise; /** * Creates a message template for messages that are sent through the SMS channel. */ createSmsTemplate(input: AWS.Pinpoint.CreateSmsTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a message template for messages that are sent through the voice channel. */ createVoiceTemplate(input: AWS.Pinpoint.CreateVoiceTemplateRequest, options: SdkCallOptions): Promise; /** * Disables the ADM channel for an application and deletes any existing settings for the channel. */ deleteAdmChannel(input: AWS.Pinpoint.DeleteAdmChannelRequest, options: SdkCallOptions): Promise; /** * Disables the APNs channel for an application and deletes any existing settings for the channel. */ deleteApnsChannel(input: AWS.Pinpoint.DeleteApnsChannelRequest, options: SdkCallOptions): Promise; /** * Disables the APNs sandbox channel for an application and deletes any existing settings for the channel. */ deleteApnsSandboxChannel(input: AWS.Pinpoint.DeleteApnsSandboxChannelRequest, options: SdkCallOptions): Promise; /** * Disables the APNs VoIP channel for an application and deletes any existing settings for the channel. */ deleteApnsVoipChannel(input: AWS.Pinpoint.DeleteApnsVoipChannelRequest, options: SdkCallOptions): Promise; /** * Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. */ deleteApnsVoipSandboxChannel(input: AWS.Pinpoint.DeleteApnsVoipSandboxChannelRequest, options: SdkCallOptions): Promise; /** * Deletes an application. */ deleteApp(input: AWS.Pinpoint.DeleteAppRequest, options: SdkCallOptions): Promise; /** * Disables the Baidu channel for an application and deletes any existing settings for the channel. */ deleteBaiduChannel(input: AWS.Pinpoint.DeleteBaiduChannelRequest, options: SdkCallOptions): Promise; /** * Deletes a campaign from an application. */ deleteCampaign(input: AWS.Pinpoint.DeleteCampaignRequest, options: SdkCallOptions): Promise; /** * Disables the email channel for an application and deletes any existing settings for the channel. */ deleteEmailChannel(input: AWS.Pinpoint.DeleteEmailChannelRequest, options: SdkCallOptions): Promise; /** * Deletes a message template for messages that were sent through the email channel. */ deleteEmailTemplate(input: AWS.Pinpoint.DeleteEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes an endpoint from an application. */ deleteEndpoint(input: AWS.Pinpoint.DeleteEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes the event stream for an application. */ deleteEventStream(input: AWS.Pinpoint.DeleteEventStreamRequest, options: SdkCallOptions): Promise; /** * Disables the GCM channel for an application and deletes any existing settings for the channel. */ deleteGcmChannel(input: AWS.Pinpoint.DeleteGcmChannelRequest, options: SdkCallOptions): Promise; /** * Deletes a message template for messages sent using the in-app message channel. */ deleteInAppTemplate(input: AWS.Pinpoint.DeleteInAppTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a journey from an application. */ deleteJourney(input: AWS.Pinpoint.DeleteJourneyRequest, options: SdkCallOptions): Promise; /** * Deletes a message template for messages that were sent through a push notification channel. */ deletePushTemplate(input: AWS.Pinpoint.DeletePushTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Pinpoint configuration for a recommender model. */ deleteRecommenderConfiguration(input: AWS.Pinpoint.DeleteRecommenderConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a segment from an application. */ deleteSegment(input: AWS.Pinpoint.DeleteSegmentRequest, options: SdkCallOptions): Promise; /** * Disables the SMS channel for an application and deletes any existing settings for the channel. */ deleteSmsChannel(input: AWS.Pinpoint.DeleteSmsChannelRequest, options: SdkCallOptions): Promise; /** * Deletes a message template for messages that were sent through the SMS channel. */ deleteSmsTemplate(input: AWS.Pinpoint.DeleteSmsTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes all the endpoints that are associated with a specific user ID. */ deleteUserEndpoints(input: AWS.Pinpoint.DeleteUserEndpointsRequest, options: SdkCallOptions): Promise; /** * Disables the voice channel for an application and deletes any existing settings for the channel. */ deleteVoiceChannel(input: AWS.Pinpoint.DeleteVoiceChannelRequest, options: SdkCallOptions): Promise; /** * Deletes a message template for messages that were sent through the voice channel. */ deleteVoiceTemplate(input: AWS.Pinpoint.DeleteVoiceTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the ADM channel for an application. */ getAdmChannel(input: AWS.Pinpoint.GetAdmChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the APNs channel for an application. */ getApnsChannel(input: AWS.Pinpoint.GetApnsChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the APNs sandbox channel for an application. */ getApnsSandboxChannel(input: AWS.Pinpoint.GetApnsSandboxChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the APNs VoIP channel for an application. */ getApnsVoipChannel(input: AWS.Pinpoint.GetApnsVoipChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application. */ getApnsVoipSandboxChannel(input: AWS.Pinpoint.GetApnsVoipSandboxChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an application. */ getApp(input: AWS.Pinpoint.GetAppRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) pre-aggregated data for a standard metric that applies to an application. */ getApplicationDateRangeKpi(input: AWS.Pinpoint.GetApplicationDateRangeKpiRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the settings for an application. */ getApplicationSettings(input: AWS.Pinpoint.GetApplicationSettingsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about all the applications that are associated with your Amazon Pinpoint account. */ getApps(input: AWS.Pinpoint.GetAppsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the Baidu channel for an application. */ getBaiduChannel(input: AWS.Pinpoint.GetBaiduChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status, configuration, and other settings for a campaign. */ getCampaign(input: AWS.Pinpoint.GetCampaignRequest, options: SdkCallOptions): Promise; /** * Retrieves information about all the activities for a campaign. */ getCampaignActivities(input: AWS.Pinpoint.GetCampaignActivitiesRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. */ getCampaignDateRangeKpi(input: AWS.Pinpoint.GetCampaignDateRangeKpiRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status, configuration, and other settings for a specific version of a campaign. */ getCampaignVersion(input: AWS.Pinpoint.GetCampaignVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status, configuration, and other settings for all versions of a campaign. */ getCampaignVersions(input: AWS.Pinpoint.GetCampaignVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application. */ getCampaigns(input: AWS.Pinpoint.GetCampaignsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the history and status of each channel for an application. */ getChannels(input: AWS.Pinpoint.GetChannelsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the email channel for an application. */ getEmailChannel(input: AWS.Pinpoint.GetEmailChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves the content and settings of a message template for messages that are sent through the email channel. */ getEmailTemplate(input: AWS.Pinpoint.GetEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the settings and attributes of a specific endpoint for an application. */ getEndpoint(input: AWS.Pinpoint.GetEndpointRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the event stream settings for an application. */ getEventStream(input: AWS.Pinpoint.GetEventStreamRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of a specific export job for an application. */ getExportJob(input: AWS.Pinpoint.GetExportJobRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of all the export jobs for an application. */ getExportJobs(input: AWS.Pinpoint.GetExportJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the GCM channel for an application. */ getGcmChannel(input: AWS.Pinpoint.GetGcmChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of a specific import job for an application. */ getImportJob(input: AWS.Pinpoint.GetImportJobRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of all the import jobs for an application. */ getImportJobs(input: AWS.Pinpoint.GetImportJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves the in-app messages targeted for the provided endpoint ID. */ getInAppMessages(input: AWS.Pinpoint.GetInAppMessagesRequest, options: SdkCallOptions): Promise; /** * Retrieves the content and settings of a message template for messages sent through the in-app channel. */ getInAppTemplate(input: AWS.Pinpoint.GetInAppTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status, configuration, and other settings for a journey. */ getJourney(input: AWS.Pinpoint.GetJourneyRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey. */ getJourneyDateRangeKpi(input: AWS.Pinpoint.GetJourneyDateRangeKpiRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity. */ getJourneyExecutionActivityMetrics(input: AWS.Pinpoint.GetJourneyExecutionActivityMetricsRequest, options: SdkCallOptions): Promise; /** * Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey. */ getJourneyExecutionMetrics(input: AWS.Pinpoint.GetJourneyExecutionMetricsRequest, options: SdkCallOptions): Promise; /** * Retrieves the content and settings of a message template for messages that are sent through a push notification channel. */ getPushTemplate(input: AWS.Pinpoint.GetPushTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an Amazon Pinpoint configuration for a recommender model. */ getRecommenderConfiguration(input: AWS.Pinpoint.GetRecommenderConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account. */ getRecommenderConfigurations(input: AWS.Pinpoint.GetRecommenderConfigurationsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application. */ getSegment(input: AWS.Pinpoint.GetSegmentRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the export jobs for a segment. */ getSegmentExportJobs(input: AWS.Pinpoint.GetSegmentExportJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the import jobs for a segment. */ getSegmentImportJobs(input: AWS.Pinpoint.GetSegmentImportJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application. */ getSegmentVersion(input: AWS.Pinpoint.GetSegmentVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application. */ getSegmentVersions(input: AWS.Pinpoint.GetSegmentVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application. */ getSegments(input: AWS.Pinpoint.GetSegmentsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the SMS channel for an application. */ getSmsChannel(input: AWS.Pinpoint.GetSmsChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves the content and settings of a message template for messages that are sent through the SMS channel. */ getSmsTemplate(input: AWS.Pinpoint.GetSmsTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves information about all the endpoints that are associated with a specific user ID. */ getUserEndpoints(input: AWS.Pinpoint.GetUserEndpointsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status and settings of the voice channel for an application. */ getVoiceChannel(input: AWS.Pinpoint.GetVoiceChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves the content and settings of a message template for messages that are sent through the voice channel. */ getVoiceTemplate(input: AWS.Pinpoint.GetVoiceTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application. */ listJourneys(input: AWS.Pinpoint.ListJourneysRequest, options: SdkCallOptions): Promise; /** * Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment. */ listTagsForResource(input: AWS.Pinpoint.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves information about all the versions of a specific message template. */ listTemplateVersions(input: AWS.Pinpoint.ListTemplateVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about all the message templates that are associated with your Amazon Pinpoint account. */ listTemplates(input: AWS.Pinpoint.ListTemplatesRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a phone number. */ phoneNumberValidate(input: AWS.Pinpoint.PhoneNumberValidateRequest, options: SdkCallOptions): Promise; /** * Creates a new event stream for an application or updates the settings of an existing event stream for an application. */ putEventStream(input: AWS.Pinpoint.PutEventStreamRequest, options: SdkCallOptions): Promise; /** * Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with. */ putEvents(input: AWS.Pinpoint.PutEventsRequest, options: SdkCallOptions): Promise; /** * Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application. */ removeAttributes(input: AWS.Pinpoint.RemoveAttributesRequest, options: SdkCallOptions): Promise; /** * Creates and sends a direct message. */ sendMessages(input: AWS.Pinpoint.SendMessagesRequest, options: SdkCallOptions): Promise; /** * Send an OTP message */ sendOTPMessage(input: AWS.Pinpoint.SendOTPMessageRequest, options: SdkCallOptions): Promise; /** * Creates and sends a message to a list of users. */ sendUsersMessages(input: AWS.Pinpoint.SendUsersMessagesRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags (keys and values) to an application, campaign, message template, or segment. */ tagResource(input: AWS.Pinpoint.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes one or more tags (keys and values) from an application, campaign, message template, or segment. */ untagResource(input: AWS.Pinpoint.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application. */ updateAdmChannel(input: AWS.Pinpoint.UpdateAdmChannelRequest, options: SdkCallOptions): Promise; /** * Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application. */ updateApnsChannel(input: AWS.Pinpoint.UpdateApnsChannelRequest, options: SdkCallOptions): Promise; /** * Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application. */ updateApnsSandboxChannel(input: AWS.Pinpoint.UpdateApnsSandboxChannelRequest, options: SdkCallOptions): Promise; /** * Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application. */ updateApnsVoipChannel(input: AWS.Pinpoint.UpdateApnsVoipChannelRequest, options: SdkCallOptions): Promise; /** * Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application. */ updateApnsVoipSandboxChannel(input: AWS.Pinpoint.UpdateApnsVoipSandboxChannelRequest, options: SdkCallOptions): Promise; /** * Updates the settings for an application. */ updateApplicationSettings(input: AWS.Pinpoint.UpdateApplicationSettingsRequest, options: SdkCallOptions): Promise; /** * Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application. */ updateBaiduChannel(input: AWS.Pinpoint.UpdateBaiduChannelRequest, options: SdkCallOptions): Promise; /** * Updates the configuration and other settings for a campaign. */ updateCampaign(input: AWS.Pinpoint.UpdateCampaignRequest, options: SdkCallOptions): Promise; /** * Enables the email channel for an application or updates the status and settings of the email channel for an application. */ updateEmailChannel(input: AWS.Pinpoint.UpdateEmailChannelRequest, options: SdkCallOptions): Promise; /** * Updates an existing message template for messages that are sent through the email channel. */ updateEmailTemplate(input: AWS.Pinpoint.UpdateEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. */ updateEndpoint(input: AWS.Pinpoint.UpdateEndpointRequest, options: SdkCallOptions): Promise; /** * Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. */ updateEndpointsBatch(input: AWS.Pinpoint.UpdateEndpointsBatchRequest, options: SdkCallOptions): Promise; /** * Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application. */ updateGcmChannel(input: AWS.Pinpoint.UpdateGcmChannelRequest, options: SdkCallOptions): Promise; /** * Updates an existing message template for messages sent through the in-app message channel. */ updateInAppTemplate(input: AWS.Pinpoint.UpdateInAppTemplateRequest, options: SdkCallOptions): Promise; /** * Updates the configuration and other settings for a journey. */ updateJourney(input: AWS.Pinpoint.UpdateJourneyRequest, options: SdkCallOptions): Promise; /** * Cancels (stops) an active journey. */ updateJourneyState(input: AWS.Pinpoint.UpdateJourneyStateRequest, options: SdkCallOptions): Promise; /** * Updates an existing message template for messages that are sent through a push notification channel. */ updatePushTemplate(input: AWS.Pinpoint.UpdatePushTemplateRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon Pinpoint configuration for a recommender model. */ updateRecommenderConfiguration(input: AWS.Pinpoint.UpdateRecommenderConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. */ updateSegment(input: AWS.Pinpoint.UpdateSegmentRequest, options: SdkCallOptions): Promise; /** * Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application. */ updateSmsChannel(input: AWS.Pinpoint.UpdateSmsChannelRequest, options: SdkCallOptions): Promise; /** * Updates an existing message template for messages that are sent through the SMS channel. */ updateSmsTemplate(input: AWS.Pinpoint.UpdateSmsTemplateRequest, options: SdkCallOptions): Promise; /** * Changes the status of a specific version of a message template to active. */ updateTemplateActiveVersion(input: AWS.Pinpoint.UpdateTemplateActiveVersionRequest, options: SdkCallOptions): Promise; /** * Enables the voice channel for an application or updates the status and settings of the voice channel for an application. */ updateVoiceChannel(input: AWS.Pinpoint.UpdateVoiceChannelRequest, options: SdkCallOptions): Promise; /** * Updates an existing message template for messages that are sent through the voice channel. */ updateVoiceTemplate(input: AWS.Pinpoint.UpdateVoiceTemplateRequest, options: SdkCallOptions): Promise; /** * Verify an OTP */ verifyOTPMessage(input: AWS.Pinpoint.VerifyOTPMessageRequest, options: SdkCallOptions): Promise; } export interface PinpointEmail { /** * Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. */ createConfigurationSet(input: AWS.PinpointEmail.CreateConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination. */ createConfigurationSetEventDestination(input: AWS.PinpointEmail.CreateConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool. */ createDedicatedIpPool(input: AWS.PinpointEmail.CreateDedicatedIpPoolRequest, options: SdkCallOptions): Promise; /** * Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test. */ createDeliverabilityTestReport(input: AWS.PinpointEmail.CreateDeliverabilityTestReportRequest, options: SdkCallOptions): Promise; /** * Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address. When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process. */ createEmailIdentity(input: AWS.PinpointEmail.CreateEmailIdentityRequest, options: SdkCallOptions): Promise; /** * Delete an existing configuration set. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. */ deleteConfigurationSet(input: AWS.PinpointEmail.DeleteConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Delete an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. */ deleteConfigurationSetEventDestination(input: AWS.PinpointEmail.DeleteConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Delete a dedicated IP pool. */ deleteDedicatedIpPool(input: AWS.PinpointEmail.DeleteDedicatedIpPoolRequest, options: SdkCallOptions): Promise; /** * Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name. */ deleteEmailIdentity(input: AWS.PinpointEmail.DeleteEmailIdentityRequest, options: SdkCallOptions): Promise; /** * Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region. */ getAccount(input: AWS.PinpointEmail.GetAccountRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of the blacklists that your dedicated IP addresses appear on. */ getBlacklistReports(input: AWS.PinpointEmail.GetBlacklistReportsRequest, options: SdkCallOptions): Promise; /** * Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. */ getConfigurationSet(input: AWS.PinpointEmail.GetConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of event destinations that are associated with a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. */ getConfigurationSetEventDestinations(input: AWS.PinpointEmail.GetConfigurationSetEventDestinationsRequest, options: SdkCallOptions): Promise; /** * Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address. */ getDedicatedIp(input: AWS.PinpointEmail.GetDedicatedIpRequest, options: SdkCallOptions): Promise; /** * List the dedicated IP addresses that are associated with your Amazon Pinpoint account. */ getDedicatedIps(input: AWS.PinpointEmail.GetDedicatedIpsRequest, options: SdkCallOptions): Promise; /** * Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing. */ getDeliverabilityDashboardOptions(input: AWS.PinpointEmail.GetDeliverabilityDashboardOptionsRequest, options: SdkCallOptions): Promise; /** * Retrieve the results of a predictive inbox placement test. */ getDeliverabilityTestReport(input: AWS.PinpointEmail.GetDeliverabilityTestReportRequest, options: SdkCallOptions): Promise; /** * Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation). */ getDomainDeliverabilityCampaign(input: AWS.PinpointEmail.GetDomainDeliverabilityCampaignRequest, options: SdkCallOptions): Promise; /** * Retrieve inbox placement and engagement rates for the domains that you use to send email. */ getDomainStatisticsReport(input: AWS.PinpointEmail.GetDomainStatisticsReportRequest, options: SdkCallOptions): Promise; /** * Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings. */ getEmailIdentity(input: AWS.PinpointEmail.GetEmailIdentityRequest, options: SdkCallOptions): Promise; /** * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. */ listConfigurationSets(input: AWS.PinpointEmail.ListConfigurationSetsRequest, options: SdkCallOptions): Promise; /** * List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region. */ listDedicatedIpPools(input: AWS.PinpointEmail.ListDedicatedIpPoolsRequest, options: SdkCallOptions): Promise; /** * Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results. */ listDeliverabilityTestReports(input: AWS.PinpointEmail.ListDeliverabilityTestReportsRequest, options: SdkCallOptions): Promise; /** * Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain. */ listDomainDeliverabilityCampaigns(input: AWS.PinpointEmail.ListDomainDeliverabilityCampaignsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. */ listEmailIdentities(input: AWS.PinpointEmail.ListEmailIdentitiesRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. */ listTagsForResource(input: AWS.PinpointEmail.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Enable or disable the automatic warm-up feature for dedicated IP addresses. */ putAccountDedicatedIpWarmupAttributes(input: AWS.PinpointEmail.PutAccountDedicatedIpWarmupAttributesRequest, options: SdkCallOptions): Promise; /** * Enable or disable the ability of your account to send email. */ putAccountSendingAttributes(input: AWS.PinpointEmail.PutAccountSendingAttributesRequest, options: SdkCallOptions): Promise; /** * Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email. */ putConfigurationSetDeliveryOptions(input: AWS.PinpointEmail.PutConfigurationSetDeliveryOptionsRequest, options: SdkCallOptions): Promise; /** * Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region. */ putConfigurationSetReputationOptions(input: AWS.PinpointEmail.PutConfigurationSetReputationOptionsRequest, options: SdkCallOptions): Promise; /** * Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region. */ putConfigurationSetSendingOptions(input: AWS.PinpointEmail.PutConfigurationSetSendingOptionsRequest, options: SdkCallOptions): Promise; /** * Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint. */ putConfigurationSetTrackingOptions(input: AWS.PinpointEmail.PutConfigurationSetTrackingOptionsRequest, options: SdkCallOptions): Promise; /** * Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation. */ putDedicatedIpInPool(input: AWS.PinpointEmail.PutDedicatedIpInPoolRequest, options: SdkCallOptions): Promise; putDedicatedIpWarmupAttributes(input: AWS.PinpointEmail.PutDedicatedIpWarmupAttributesRequest, options: SdkCallOptions): Promise; /** * Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing. */ putDeliverabilityDashboardOption(input: AWS.PinpointEmail.PutDeliverabilityDashboardOptionRequest, options: SdkCallOptions): Promise; /** * Used to enable or disable DKIM authentication for an email identity. */ putEmailIdentityDkimAttributes(input: AWS.PinpointEmail.PutEmailIdentityDkimAttributesRequest, options: SdkCallOptions): Promise; /** * Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled). */ putEmailIdentityFeedbackAttributes(input: AWS.PinpointEmail.PutEmailIdentityFeedbackAttributesRequest, options: SdkCallOptions): Promise; /** * Used to enable or disable the custom Mail-From domain configuration for an email identity. */ putEmailIdentityMailFromAttributes(input: AWS.PinpointEmail.PutEmailIdentityMailFromAttributesRequest, options: SdkCallOptions): Promise; /** * Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages: Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you. Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message. */ sendEmail(input: AWS.PinpointEmail.SendEmailRequest, options: SdkCallOptions): Promise; /** * Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. */ tagResource(input: AWS.PinpointEmail.TagResourceRequest, options: SdkCallOptions): Promise; /** * Remove one or more tags (keys and values) from a specified resource. */ untagResource(input: AWS.PinpointEmail.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update the configuration of an event destination for a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. */ updateConfigurationSetEventDestination(input: AWS.PinpointEmail.UpdateConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; } export interface PinpointSMSVoice { /** * Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it. */ createConfigurationSet(input: AWS.PinpointSMSVoice.CreateConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Create a new event destination in a configuration set. */ createConfigurationSetEventDestination(input: AWS.PinpointSMSVoice.CreateConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Deletes an existing configuration set. */ deleteConfigurationSet(input: AWS.PinpointSMSVoice.DeleteConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Deletes an event destination in a configuration set. */ deleteConfigurationSetEventDestination(input: AWS.PinpointSMSVoice.DeleteConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination. */ getConfigurationSetEventDestinations(input: AWS.PinpointSMSVoice.GetConfigurationSetEventDestinationsRequest, options: SdkCallOptions): Promise; /** * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. */ listConfigurationSets(input: AWS.PinpointSMSVoice.ListConfigurationSetsRequest, options: SdkCallOptions): Promise; /** * Create a new voice message and send it to a recipient's phone number. */ sendVoiceMessage(input: AWS.PinpointSMSVoice.SendVoiceMessageRequest, options: SdkCallOptions): Promise; /** * Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails. */ updateConfigurationSetEventDestination(input: AWS.PinpointSMSVoice.UpdateConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; } export interface PinpointSMSVoiceV2 { /** * Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools. If the origination identity configuration doesn't match the pool's configuration, an Error is returned. */ associateOriginationIdentity(input: AWS.PinpointSMSVoiceV2.AssociateOriginationIdentityRequest, options: SdkCallOptions): Promise; /** * Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it. A configuration set is a set of rules that you apply to the SMS and voice messages that you send. When you send a message, you can optionally specify a single configuration set. */ createConfigurationSet(input: AWS.PinpointSMSVoiceV2.CreateConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Creates a new event destination in a configuration set. An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination. */ createEventDestination(input: AWS.PinpointSMSVoiceV2.CreateEventDestinationRequest, options: SdkCallOptions): Promise; /** * Creates a new opt-out list. If the opt-out list name already exists, an Error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide. */ createOptOutList(input: AWS.PinpointSMSVoiceV2.CreateOptOutListRequest, options: SdkCallOptions): Promise; /** * Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false. If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools. */ createPool(input: AWS.PinpointSMSVoiceV2.CreatePoolRequest, options: SdkCallOptions): Promise; /** * Deletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages. */ deleteConfigurationSet(input: AWS.PinpointSMSVoiceV2.DeleteConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Deletes an existing default message type on a configuration set. A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account. */ deleteDefaultMessageType(input: AWS.PinpointSMSVoiceV2.DeleteDefaultMessageTypeRequest, options: SdkCallOptions): Promise; /** * Deletes an existing default sender ID on a configuration set. A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region. */ deleteDefaultSenderId(input: AWS.PinpointSMSVoiceV2.DeleteDefaultSenderIdRequest, options: SdkCallOptions): Promise; /** * Deletes an existing event destination. An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. */ deleteEventDestination(input: AWS.PinpointSMSVoiceV2.DeleteEventDestinationRequest, options: SdkCallOptions): Promise; /** * Deletes an existing keyword from an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. Keywords "HELP" and "STOP" can't be deleted or modified. */ deleteKeyword(input: AWS.PinpointSMSVoiceV2.DeleteKeywordRequest, options: SdkCallOptions): Promise; /** * Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an Error is returned. */ deleteOptOutList(input: AWS.PinpointSMSVoiceV2.DeleteOptOutListRequest, options: SdkCallOptions): Promise; /** * Deletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an Error is returned. */ deleteOptedOutNumber(input: AWS.PinpointSMSVoiceV2.DeleteOptedOutNumberRequest, options: SdkCallOptions): Promise; /** * Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection is enabled, an Error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. */ deletePool(input: AWS.PinpointSMSVoiceV2.DeletePoolRequest, options: SdkCallOptions): Promise; /** * Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide. */ deleteTextMessageSpendLimitOverride(input: AWS.PinpointSMSVoiceV2.DeleteTextMessageSpendLimitOverrideRequest, options: SdkCallOptions): Promise; /** * Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide. */ deleteVoiceMessageSpendLimitOverride(input: AWS.PinpointSMSVoiceV2.DeleteVoiceMessageSpendLimitOverrideRequest, options: SdkCallOptions): Promise; /** * Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request. New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse. */ describeAccountAttributes(input: AWS.PinpointSMSVoiceV2.DescribeAccountAttributesRequest, options: SdkCallOptions): Promise; /** * Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide. */ describeAccountLimits(input: AWS.PinpointSMSVoiceV2.DescribeAccountLimitsRequest, options: SdkCallOptions): Promise; /** * Describes the specified configuration sets or all in your account. If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets. If you specify a configuration set name that isn't valid, an error is returned. */ describeConfigurationSets(input: AWS.PinpointSMSVoiceV2.DescribeConfigurationSetsRequest, options: SdkCallOptions): Promise; /** * Describes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an Error is returned. */ describeKeywords(input: AWS.PinpointSMSVoiceV2.DescribeKeywordsRequest, options: SdkCallOptions): Promise; /** * Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists. If you specify an opt-out list name that isn't valid, an Error is returned. */ describeOptOutLists(input: AWS.PinpointSMSVoiceV2.DescribeOptOutListsRequest, options: SdkCallOptions): Promise; /** * Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list. If you specify an opted out number that isn't valid, an Error is returned. */ describeOptedOutNumbers(input: AWS.PinpointSMSVoiceV2.DescribeOptedOutNumbersRequest, options: SdkCallOptions): Promise; /** * Describes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an Error is returned. */ describePhoneNumbers(input: AWS.PinpointSMSVoiceV2.DescribePhoneNumbersRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified pools or all pools associated with your Amazon Web Services account. If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools. If you specify a pool ID that isn't valid, an Error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account. */ describePools(input: AWS.PinpointSMSVoiceV2.DescribePoolsRequest, options: SdkCallOptions): Promise; /** * Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an Error is returned. */ describeSenderIds(input: AWS.PinpointSMSVoiceV2.DescribeSenderIdsRequest, options: SdkCallOptions): Promise; /** * Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide. */ describeSpendLimits(input: AWS.PinpointSMSVoiceV2.DescribeSpendLimitsRequest, options: SdkCallOptions): Promise; /** * Removes the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an Error is returned. */ disassociateOriginationIdentity(input: AWS.PinpointSMSVoiceV2.DisassociateOriginationIdentityRequest, options: SdkCallOptions): Promise; /** * Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that meet the filter criteria. */ listPoolOriginationIdentities(input: AWS.PinpointSMSVoiceV2.ListPoolOriginationIdentitiesRequest, options: SdkCallOptions): Promise; /** * List all tags associated with a resource. */ listTagsForResource(input: AWS.PinpointSMSVoiceV2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you specify a keyword that isn't valid, an Error is returned. */ putKeyword(input: AWS.PinpointSMSVoiceV2.PutKeywordRequest, options: SdkCallOptions): Promise; /** * Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned. */ putOptedOutNumber(input: AWS.PinpointSMSVoiceV2.PutOptedOutNumberRequest, options: SdkCallOptions): Promise; /** * Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages. If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned. */ releasePhoneNumber(input: AWS.PinpointSMSVoiceV2.ReleasePhoneNumberRequest, options: SdkCallOptions): Promise; /** * Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide. */ requestPhoneNumber(input: AWS.PinpointSMSVoiceV2.RequestPhoneNumberRequest, options: SdkCallOptions): Promise; /** * Creates a new text message and sends it to a recipient's phone number. SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide. */ sendTextMessage(input: AWS.PinpointSMSVoiceV2.SendTextMessageRequest, options: SdkCallOptions): Promise; /** * Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message. */ sendVoiceMessage(input: AWS.PinpointSMSVoiceV2.SendVoiceMessageRequest, options: SdkCallOptions): Promise; /** * Sets the default message type on a configuration set. Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account. */ setDefaultMessageType(input: AWS.PinpointSMSVoiceV2.SetDefaultMessageTypeRequest, options: SdkCallOptions): Promise; /** * Sets default sender ID on a configuration set. When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account. */ setDefaultSenderId(input: AWS.PinpointSMSVoiceV2.SetDefaultSenderIdRequest, options: SdkCallOptions): Promise; /** * Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services. */ setTextMessageSpendLimitOverride(input: AWS.PinpointSMSVoiceV2.SetTextMessageSpendLimitOverrideRequest, options: SdkCallOptions): Promise; /** * Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services. */ setVoiceMessageSpendLimitOverride(input: AWS.PinpointSMSVoiceV2.SetVoiceMessageSpendLimitOverrideRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide. */ tagResource(input: AWS.PinpointSMSVoiceV2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide. */ untagResource(input: AWS.PinpointSMSVoiceV2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination. You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS. */ updateEventDestination(input: AWS.PinpointSMSVoiceV2.UpdateEventDestinationRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an Error is returned. */ updatePhoneNumber(input: AWS.PinpointSMSVoiceV2.UpdatePhoneNumberRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes. */ updatePool(input: AWS.PinpointSMSVoiceV2.UpdatePoolRequest, options: SdkCallOptions): Promise; } export interface Polly { /** * Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs. For more information, see Managing Lexicons. */ deleteLexicon(input: AWS.Polly.DeleteLexiconInput, options: SdkCallOptions): Promise; /** * Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name. When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices. For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from. You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices. This operation requires permissions to perform the polly:DescribeVoices action. */ describeVoices(input: AWS.Polly.DescribeVoicesInput, options: SdkCallOptions): Promise; /** * Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons. */ getLexicon(input: AWS.Polly.GetLexiconInput, options: SdkCallOptions): Promise; /** * Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task. */ getSpeechSynthesisTask(input: AWS.Polly.GetSpeechSynthesisTaskInput, options: SdkCallOptions): Promise; /** * Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons. */ listLexicons(input: AWS.Polly.ListLexiconsInput, options: SdkCallOptions): Promise; /** * Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed. */ listSpeechSynthesisTasks(input: AWS.Polly.ListSpeechSynthesisTasksInput, options: SdkCallOptions): Promise; /** * Stores a pronunciation lexicon in an Amazon Web Services Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation. For more information, see Managing Lexicons. */ putLexicon(input: AWS.Polly.PutLexiconInput, options: SdkCallOptions): Promise; /** * Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task. */ startSpeechSynthesisTask(input: AWS.Polly.StartSpeechSynthesisTaskInput, options: SdkCallOptions): Promise; /** * Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works. */ synthesizeSpeech(input: AWS.Polly.SynthesizeSpeechInput, options: SdkCallOptions): Promise; } export interface Pricing { /** * Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge. */ describeServices(input: AWS.Pricing.DescribeServicesRequest, options: SdkCallOptions): Promise; /** * Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Billing and Cost Management User Guide. */ getAttributeValues(input: AWS.Pricing.GetAttributeValuesRequest, options: SdkCallOptions): Promise; /** * Returns a list of all products that match the filter criteria. */ getProducts(input: AWS.Pricing.GetProductsRequest, options: SdkCallOptions): Promise; } export interface PrivateNetworks { /** * Acknowledges that the specified network order was received. */ acknowledgeOrderReceipt(input: AWS.PrivateNetworks.AcknowledgeOrderReceiptRequest, options: SdkCallOptions): Promise; /** * Activates the specified device identifier. */ activateDeviceIdentifier(input: AWS.PrivateNetworks.ActivateDeviceIdentifierRequest, options: SdkCallOptions): Promise; /** * Activates the specified network site. */ activateNetworkSite(input: AWS.PrivateNetworks.ActivateNetworkSiteRequest, options: SdkCallOptions): Promise; /** * Configures the specified network resource. Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide. */ configureAccessPoint(input: AWS.PrivateNetworks.ConfigureAccessPointRequest, options: SdkCallOptions): Promise; /** * Creates a network. */ createNetwork(input: AWS.PrivateNetworks.CreateNetworkRequest, options: SdkCallOptions): Promise; /** * Creates a network site. */ createNetworkSite(input: AWS.PrivateNetworks.CreateNetworkSiteRequest, options: SdkCallOptions): Promise; /** * Deactivates the specified device identifier. */ deactivateDeviceIdentifier(input: AWS.PrivateNetworks.DeactivateDeviceIdentifierRequest, options: SdkCallOptions): Promise; /** * Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G. */ deleteNetwork(input: AWS.PrivateNetworks.DeleteNetworkRequest, options: SdkCallOptions): Promise; /** * Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide. */ deleteNetworkSite(input: AWS.PrivateNetworks.DeleteNetworkSiteRequest, options: SdkCallOptions): Promise; /** * Gets the specified device identifier. */ getDeviceIdentifier(input: AWS.PrivateNetworks.GetDeviceIdentifierRequest, options: SdkCallOptions): Promise; /** * Gets the specified network. */ getNetwork(input: AWS.PrivateNetworks.GetNetworkRequest, options: SdkCallOptions): Promise; /** * Gets the specified network resource. */ getNetworkResource(input: AWS.PrivateNetworks.GetNetworkResourceRequest, options: SdkCallOptions): Promise; /** * Gets the specified network site. */ getNetworkSite(input: AWS.PrivateNetworks.GetNetworkSiteRequest, options: SdkCallOptions): Promise; /** * Gets the specified order. */ getOrder(input: AWS.PrivateNetworks.GetOrderRequest, options: SdkCallOptions): Promise; /** * Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group. <p>If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters. */ listDeviceIdentifiers(input: AWS.PrivateNetworks.ListDeviceIdentifiersRequest, options: SdkCallOptions): Promise; /** * Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources. If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters. */ listNetworkResources(input: AWS.PrivateNetworks.ListNetworkResourcesRequest, options: SdkCallOptions): Promise; /** * Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site. */ listNetworkSites(input: AWS.PrivateNetworks.ListNetworkSitesRequest, options: SdkCallOptions): Promise; /** * Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network. */ listNetworks(input: AWS.PrivateNetworks.ListNetworksRequest, options: SdkCallOptions): Promise; /** * Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order. If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters. */ listOrders(input: AWS.PrivateNetworks.ListOrdersRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.PrivateNetworks.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds tags to the specified resource. */ tagResource(input: AWS.PrivateNetworks.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from the specified resource. */ untagResource(input: AWS.PrivateNetworks.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified network site. */ updateNetworkSite(input: AWS.PrivateNetworks.UpdateNetworkSiteRequest, options: SdkCallOptions): Promise; /** * Updates the specified network site plan. */ updateNetworkSitePlan(input: AWS.PrivateNetworks.UpdateNetworkSitePlanRequest, options: SdkCallOptions): Promise; } export interface Proton { /** * In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account. For more information, see Environment account connections in the Proton User guide. */ acceptEnvironmentAccountConnection(input: AWS.Proton.AcceptEnvironmentAccountConnectionInput, options: SdkCallOptions): Promise; /** * Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status). For more information about components, see Proton components in the Proton User Guide. */ cancelComponentDeployment(input: AWS.Proton.CancelComponentDeploymentInput, options: SdkCallOptions): Promise; /** * Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more information, see Update an environment in the Proton User guide. The following list includes potential cancellation scenarios. If the cancellation attempt succeeds, the resulting deployment state is CANCELLED. If the cancellation attempt fails, the resulting deployment state is FAILED. If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect. */ cancelEnvironmentDeployment(input: AWS.Proton.CancelEnvironmentDeploymentInput, options: SdkCallOptions): Promise; /** * Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the Proton User guide. The following list includes potential cancellation scenarios. If the cancellation attempt succeeds, the resulting deployment state is CANCELLED. If the cancellation attempt fails, the resulting deployment state is FAILED. If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect. */ cancelServiceInstanceDeployment(input: AWS.Proton.CancelServiceInstanceDeploymentInput, options: SdkCallOptions): Promise; /** * Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the Proton User guide. The following list includes potential cancellation scenarios. If the cancellation attempt succeeds, the resulting deployment state is CANCELLED. If the cancellation attempt fails, the resulting deployment state is FAILED. If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect. */ cancelServicePipelineDeployment(input: AWS.Proton.CancelServicePipelineDeploymentInput, options: SdkCallOptions): Promise; /** * Create an Proton component. A component is an infrastructure extension for a service instance. For more information about components, see Proton components in the Proton User Guide. */ createComponent(input: AWS.Proton.CreateComponentInput, options: SdkCallOptions): Promise; /** * Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. You can provision environments using the following methods: Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources. Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources. For more information, see Environments and Provisioning methods in the Proton User Guide. */ createEnvironment(input: AWS.Proton.CreateEnvironmentInput, options: SdkCallOptions): Promise; /** * Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account. An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton User guide. */ createEnvironmentAccountConnection(input: AWS.Proton.CreateEnvironmentAccountConnectionInput, options: SdkCallOptions): Promise; /** * Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide. You can create an environment template in one of the two following ways: Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure. Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the Proton User Guide. */ createEnvironmentTemplate(input: AWS.Proton.CreateEnvironmentTemplateInput, options: SdkCallOptions): Promise; /** * Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version. */ createEnvironmentTemplateVersion(input: AWS.Proton.CreateEnvironmentTemplateVersionInput, options: SdkCallOptions): Promise; /** * Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed provisioning, or synced templates). When you create a repository link, Proton creates a service-linked role for you. For more information, see Self-managed provisioning, Template bundles, and Template sync configurations in the Proton User Guide. */ createRepository(input: AWS.Proton.CreateRepositoryInput, options: SdkCallOptions): Promise; /** * Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton User Guide. */ createService(input: AWS.Proton.CreateServiceInput, options: SdkCallOptions): Promise; /** * Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Proton templates in the Proton User Guide. */ createServiceTemplate(input: AWS.Proton.CreateServiceTemplateInput, options: SdkCallOptions): Promise; /** * Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version. */ createServiceTemplateVersion(input: AWS.Proton.CreateServiceTemplateVersionInput, options: SdkCallOptions): Promise; /** * Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository. When a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton User Guide. */ createTemplateSyncConfig(input: AWS.Proton.CreateTemplateSyncConfigInput, options: SdkCallOptions): Promise; /** * Delete an Proton component resource. For more information about components, see Proton components in the Proton User Guide. */ deleteComponent(input: AWS.Proton.DeleteComponentInput, options: SdkCallOptions): Promise; /** * Delete an environment. */ deleteEnvironment(input: AWS.Proton.DeleteEnvironmentInput, options: SdkCallOptions): Promise; /** * In an environment account, delete an environment account connection. After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection. For more information, see Environment account connections in the Proton User guide. */ deleteEnvironmentAccountConnection(input: AWS.Proton.DeleteEnvironmentAccountConnectionInput, options: SdkCallOptions): Promise; /** * If no other major or minor versions of an environment template exist, delete the environment template. */ deleteEnvironmentTemplate(input: AWS.Proton.DeleteEnvironmentTemplateInput, options: SdkCallOptions): Promise; /** * If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the Recommended version. Delete the Recommended version of the environment template if no other major versions or minor versions of the environment template exist. A major version of an environment template is a version that's not backward compatible. Delete a minor version of an environment template if it isn't the Recommended version. Delete a Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version of an environment template is a version that's backward compatible. */ deleteEnvironmentTemplateVersion(input: AWS.Proton.DeleteEnvironmentTemplateVersionInput, options: SdkCallOptions): Promise; /** * De-register and unlink your repository. */ deleteRepository(input: AWS.Proton.DeleteRepositoryInput, options: SdkCallOptions): Promise; /** * Delete a service, with its instances and pipeline. You can't delete a service if it has any service instances that have components attached to them. For more information about components, see Proton components in the Proton User Guide. */ deleteService(input: AWS.Proton.DeleteServiceInput, options: SdkCallOptions): Promise; /** * If no other major or minor versions of the service template exist, delete the service template. */ deleteServiceTemplate(input: AWS.Proton.DeleteServiceTemplateInput, options: SdkCallOptions): Promise; /** * If no other minor versions of a service template exist, delete a major version of the service template if it's not the Recommended version. Delete the Recommended version of the service template if no other major versions or minor versions of the service template exist. A major version of a service template is a version that isn't backwards compatible. Delete a minor version of a service template if it's not the Recommended version. Delete a Recommended minor version of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards compatible. */ deleteServiceTemplateVersion(input: AWS.Proton.DeleteServiceTemplateVersionInput, options: SdkCallOptions): Promise; /** * Delete a template sync configuration. */ deleteTemplateSyncConfig(input: AWS.Proton.DeleteTemplateSyncConfigInput, options: SdkCallOptions): Promise; /** * Get detail data for Proton account-wide settings. */ getAccountSettings(input: AWS.Proton.GetAccountSettingsInput, options: SdkCallOptions): Promise; /** * Get detailed data for a component. For more information about components, see Proton components in the Proton User Guide. */ getComponent(input: AWS.Proton.GetComponentInput, options: SdkCallOptions): Promise; /** * Get detailed data for an environment. */ getEnvironment(input: AWS.Proton.GetEnvironmentInput, options: SdkCallOptions): Promise; /** * In an environment account, get the detailed data for an environment account connection. For more information, see Environment account connections in the Proton User guide. */ getEnvironmentAccountConnection(input: AWS.Proton.GetEnvironmentAccountConnectionInput, options: SdkCallOptions): Promise; /** * Get detailed data for an environment template. */ getEnvironmentTemplate(input: AWS.Proton.GetEnvironmentTemplateInput, options: SdkCallOptions): Promise; /** * Get detailed data for a major or minor version of an environment template. */ getEnvironmentTemplateVersion(input: AWS.Proton.GetEnvironmentTemplateVersionInput, options: SdkCallOptions): Promise; /** * Get detail data for a linked repository. */ getRepository(input: AWS.Proton.GetRepositoryInput, options: SdkCallOptions): Promise; /** * Get the sync status of a repository used for Proton template sync. For more information about template sync, see . A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC). For more information about ABAC, see ABAC in the Proton User Guide. */ getRepositorySyncStatus(input: AWS.Proton.GetRepositorySyncStatusInput, options: SdkCallOptions): Promise; /** * Get detailed data for a service. */ getService(input: AWS.Proton.GetServiceInput, options: SdkCallOptions): Promise; /** * Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment. */ getServiceInstance(input: AWS.Proton.GetServiceInstanceInput, options: SdkCallOptions): Promise; /** * Get detailed data for a service template. */ getServiceTemplate(input: AWS.Proton.GetServiceTemplateInput, options: SdkCallOptions): Promise; /** * Get detailed data for a major or minor version of a service template. */ getServiceTemplateVersion(input: AWS.Proton.GetServiceTemplateVersionInput, options: SdkCallOptions): Promise; /** * Get detail data for a template sync configuration. */ getTemplateSyncConfig(input: AWS.Proton.GetTemplateSyncConfigInput, options: SdkCallOptions): Promise; /** * Get the status of a template sync. */ getTemplateSyncStatus(input: AWS.Proton.GetTemplateSyncStatusInput, options: SdkCallOptions): Promise; /** * Get a list of component Infrastructure as Code (IaC) outputs. For more information about components, see Proton components in the Proton User Guide. */ listComponentOutputs(input: AWS.Proton.ListComponentOutputsInput, options: SdkCallOptions): Promise; /** * List provisioned resources for a component with details. For more information about components, see Proton components in the Proton User Guide. */ listComponentProvisionedResources(input: AWS.Proton.ListComponentProvisionedResourcesInput, options: SdkCallOptions): Promise; /** * List components with summary data. You can filter the result list by environment, service, or a single service instance. For more information about components, see Proton components in the Proton User Guide. */ listComponents(input: AWS.Proton.ListComponentsInput, options: SdkCallOptions): Promise; /** * View a list of environment account connections. For more information, see Environment account connections in the Proton User guide. */ listEnvironmentAccountConnections(input: AWS.Proton.ListEnvironmentAccountConnectionsInput, options: SdkCallOptions): Promise; /** * List the infrastructure as code outputs for your environment. */ listEnvironmentOutputs(input: AWS.Proton.ListEnvironmentOutputsInput, options: SdkCallOptions): Promise; /** * List the provisioned resources for your environment. */ listEnvironmentProvisionedResources(input: AWS.Proton.ListEnvironmentProvisionedResourcesInput, options: SdkCallOptions): Promise; /** * List major or minor versions of an environment template with detail data. */ listEnvironmentTemplateVersions(input: AWS.Proton.ListEnvironmentTemplateVersionsInput, options: SdkCallOptions): Promise; /** * List environment templates. */ listEnvironmentTemplates(input: AWS.Proton.ListEnvironmentTemplatesInput, options: SdkCallOptions): Promise; /** * List environments with detail data summaries. */ listEnvironments(input: AWS.Proton.ListEnvironmentsInput, options: SdkCallOptions): Promise; /** * List linked repositories with detail data. */ listRepositories(input: AWS.Proton.ListRepositoriesInput, options: SdkCallOptions): Promise; /** * List repository sync definitions with detail data. */ listRepositorySyncDefinitions(input: AWS.Proton.ListRepositorySyncDefinitionsInput, options: SdkCallOptions): Promise; /** * Get a list service of instance Infrastructure as Code (IaC) outputs. */ listServiceInstanceOutputs(input: AWS.Proton.ListServiceInstanceOutputsInput, options: SdkCallOptions): Promise; /** * List provisioned resources for a service instance with details. */ listServiceInstanceProvisionedResources(input: AWS.Proton.ListServiceInstanceProvisionedResourcesInput, options: SdkCallOptions): Promise; /** * List service instances with summary data. */ listServiceInstances(input: AWS.Proton.ListServiceInstancesInput, options: SdkCallOptions): Promise; /** * Get a list of service pipeline Infrastructure as Code (IaC) outputs. */ listServicePipelineOutputs(input: AWS.Proton.ListServicePipelineOutputsInput, options: SdkCallOptions): Promise; /** * List provisioned resources for a service and pipeline with details. */ listServicePipelineProvisionedResources(input: AWS.Proton.ListServicePipelineProvisionedResourcesInput, options: SdkCallOptions): Promise; /** * List major or minor versions of a service template with detail data. */ listServiceTemplateVersions(input: AWS.Proton.ListServiceTemplateVersionsInput, options: SdkCallOptions): Promise; /** * List service templates with detail data. */ listServiceTemplates(input: AWS.Proton.ListServiceTemplatesInput, options: SdkCallOptions): Promise; /** * List services with summaries of detail data. */ listServices(input: AWS.Proton.ListServicesInput, options: SdkCallOptions): Promise; /** * List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide. */ listTagsForResource(input: AWS.Proton.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Notify Proton of status changes to a provisioned resource when you use self-managed provisioning. For more information, see Self-managed provisioning in the Proton User Guide. */ notifyResourceDeploymentStatusChange(input: AWS.Proton.NotifyResourceDeploymentStatusChangeInput, options: SdkCallOptions): Promise; /** * In a management account, reject an environment account connection from another environment account. After you reject an environment account connection request, you can't accept or use the rejected environment account connection. You can’t reject an environment account connection that's connected to an environment. For more information, see Environment account connections in the Proton User guide. */ rejectEnvironmentAccountConnection(input: AWS.Proton.RejectEnvironmentAccountConnectionInput, options: SdkCallOptions): Promise; /** * Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource. For more information, see Proton resources and tagging in the Proton User Guide. */ tagResource(input: AWS.Proton.TagResourceInput, options: SdkCallOptions): Promise; /** * Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource. For more information, see Proton resources and tagging in the Proton User Guide. */ untagResource(input: AWS.Proton.UntagResourceInput, options: SdkCallOptions): Promise; /** * Update Proton settings that are used for multiple services in the Amazon Web Services account. */ updateAccountSettings(input: AWS.Proton.UpdateAccountSettingsInput, options: SdkCallOptions): Promise; /** * Update a component. There are a few modes for updating a component. The deploymentType field defines the mode. You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS. For more information about components, see Proton components in the Proton User Guide. */ updateComponent(input: AWS.Proton.UpdateComponentInput, options: SdkCallOptions): Promise; /** * Update an environment. If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection. You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment. If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter. You can't update or connect the environment to an environment account connection if it isn't already associated with an environment connection. You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both. If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter. If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters. For more information, see Environments and Provisioning methods in the Proton User Guide. There are four modes for updating an environment. The deploymentType field defines the mode. NONE In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. CURRENT_VERSION In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type. MINOR_VERSION In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use. MAJOR_VERSION In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version. */ updateEnvironment(input: AWS.Proton.UpdateEnvironmentInput, options: SdkCallOptions): Promise; /** * In an environment account, update an environment account connection to use a new IAM role. For more information, see Environment account connections in the Proton User guide. */ updateEnvironmentAccountConnection(input: AWS.Proton.UpdateEnvironmentAccountConnectionInput, options: SdkCallOptions): Promise; /** * Update an environment template. */ updateEnvironmentTemplate(input: AWS.Proton.UpdateEnvironmentTemplateInput, options: SdkCallOptions): Promise; /** * Update a major or minor version of an environment template. */ updateEnvironmentTemplateVersion(input: AWS.Proton.UpdateEnvironmentTemplateVersionInput, options: SdkCallOptions): Promise; /** * Edit a service description or use a spec to add and delete service instances. Existing service instances and the service pipeline can't be edited using this API. They can only be deleted. Use the description parameter to modify the description. Edit the spec parameter to add or delete instances. You can't delete a service instance (remove it from the spec) if it has an attached component. For more information about components, see Proton components in the Proton User Guide. */ updateService(input: AWS.Proton.UpdateServiceInput, options: SdkCallOptions): Promise; /** * Update a service instance. There are a few modes for updating a service instance. The deploymentType field defines the mode. You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS. For more information about components, see Proton components in the Proton User Guide. */ updateServiceInstance(input: AWS.Proton.UpdateServiceInstanceInput, options: SdkCallOptions): Promise; /** * Update the service pipeline. There are four modes for updating a service pipeline. The deploymentType field defines the mode. NONE In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. CURRENT_VERSION In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type. MINOR_VERSION In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use. MAJOR_VERSION In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that's higher than the major version in use and a minor version. */ updateServicePipeline(input: AWS.Proton.UpdateServicePipelineInput, options: SdkCallOptions): Promise; /** * Update a service template. */ updateServiceTemplate(input: AWS.Proton.UpdateServiceTemplateInput, options: SdkCallOptions): Promise; /** * Update a major or minor version of a service template. */ updateServiceTemplateVersion(input: AWS.Proton.UpdateServiceTemplateVersionInput, options: SdkCallOptions): Promise; /** * Update template sync configuration parameters, except for the templateName and templateType. Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository. */ updateTemplateSyncConfig(input: AWS.Proton.UpdateTemplateSyncConfigInput, options: SdkCallOptions): Promise; } export interface QLDB { /** * Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE. You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires. */ cancelJournalKinesisStream(input: AWS.QLDB.CancelJournalKinesisStreamRequest, options: SdkCallOptions): Promise; /** * Creates a new ledger in your Amazon Web Services account in the current Region. */ createLedger(input: AWS.QLDB.CreateLedgerRequest, options: SdkCallOptions): Promise; /** * Deletes a ledger and all of its contents. This action is irreversible. If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false. */ deleteLedger(input: AWS.QLDB.DeleteLedgerRequest, options: SdkCallOptions): Promise<{}>; /** * Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request. This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide. */ describeJournalKinesisStream(input: AWS.QLDB.DescribeJournalKinesisStreamRequest, options: SdkCallOptions): Promise; /** * Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. */ describeJournalS3Export(input: AWS.QLDB.DescribeJournalS3ExportRequest, options: SdkCallOptions): Promise; /** * Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created. */ describeLedger(input: AWS.QLDB.DescribeLedgerRequest, options: SdkCallOptions): Promise; /** * Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format. In JSON Lines format, each journal block in the exported data object is a valid JSON object that is delimited by a newline. You can use this format to easily integrate JSON exports with analytics tools such as Glue and Amazon Athena because these services can parse newline-delimited JSON automatically. For more information about the format, see JSON Lines. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException. */ exportJournalToS3(input: AWS.QLDB.ExportJournalToS3Request, options: SdkCallOptions): Promise; /** * Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided. For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide. If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException. If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException. If no block exists with the specified address, then throws InvalidParameterException. */ getBlock(input: AWS.QLDB.GetBlockRequest, options: SdkCallOptions): Promise; /** * Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address. */ getDigest(input: AWS.QLDB.GetDigestRequest, options: SdkCallOptions): Promise; /** * Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided. */ getRevision(input: AWS.QLDB.GetRevisionRequest, options: SdkCallOptions): Promise; /** * Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream. This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide. This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times. */ listJournalKinesisStreamsForLedger(input: AWS.QLDB.ListJournalKinesisStreamsForLedgerRequest, options: SdkCallOptions): Promise; /** * Returns an array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. */ listJournalS3Exports(input: AWS.QLDB.ListJournalS3ExportsRequest, options: SdkCallOptions): Promise; /** * Returns an array of journal export job descriptions for a specified ledger. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times. This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide. */ listJournalS3ExportsForLedger(input: AWS.QLDB.ListJournalS3ExportsForLedgerRequest, options: SdkCallOptions): Promise; /** * Returns an array of ledger summaries that are associated with the current Amazon Web Services account and Region. This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times. */ listLedgers(input: AWS.QLDB.ListLedgersRequest, options: SdkCallOptions): Promise; /** * Returns all tags for a specified Amazon QLDB resource. */ listTagsForResource(input: AWS.QLDB.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource. */ streamJournalToKinesis(input: AWS.QLDB.StreamJournalToKinesisRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to a specified Amazon QLDB resource. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error. */ tagResource(input: AWS.QLDB.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove. */ untagResource(input: AWS.QLDB.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates properties on a ledger. */ updateLedger(input: AWS.QLDB.UpdateLedgerRequest, options: SdkCallOptions): Promise; /** * Updates the permissions mode of a ledger. Before you switch to the STANDARD permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide. */ updateLedgerPermissionsMode(input: AWS.QLDB.UpdateLedgerPermissionsModeRequest, options: SdkCallOptions): Promise; } export interface QLDBSession { /** * Sends a command to an Amazon QLDB ledger. Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger. If you are working with an AWS SDK, use the QLDB driver. The driver provides a high-level abstraction layer above this QLDB Session data plane and manages SendCommand API calls for you. For information and a list of supported programming languages, see Getting started with the driver in the Amazon QLDB Developer Guide. If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line interface that uses the QLDB driver to interact with a ledger. For information, see Accessing Amazon QLDB using the QLDB shell. */ sendCommand(input: AWS.QLDBSession.SendCommandRequest, options: SdkCallOptions): Promise; } export interface QuickSight { /** * Cancels an ongoing ingestion of data into SPICE. */ cancelIngestion(input: AWS.QuickSight.CancelIngestionRequest, options: SdkCallOptions): Promise; /** * Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation. */ createAccountCustomization(input: AWS.QuickSight.CreateAccountCustomizationRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide. You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide. */ createAccountSubscription(input: AWS.QuickSight.CreateAccountSubscriptionRequest, options: SdkCallOptions): Promise; /** * Creates an analysis in Amazon QuickSight. */ createAnalysis(input: AWS.QuickSight.CreateAnalysisRequest, options: SdkCallOptions): Promise; /** * Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account. */ createDashboard(input: AWS.QuickSight.CreateDashboardRequest, options: SdkCallOptions): Promise; /** * Creates a dataset. This operation doesn't support datasets that include uploaded files as a source. */ createDataSet(input: AWS.QuickSight.CreateDataSetRequest, options: SdkCallOptions): Promise; /** * Creates a data source. */ createDataSource(input: AWS.QuickSight.CreateDataSourceRequest, options: SdkCallOptions): Promise; /** * Creates an empty shared folder. */ createFolder(input: AWS.QuickSight.CreateFolderRequest, options: SdkCallOptions): Promise; /** * Adds an asset, such as a dashboard, analysis, or dataset into a folder. */ createFolderMembership(input: AWS.QuickSight.CreateFolderMembershipRequest, options: SdkCallOptions): Promise; /** * Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support. The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object. */ createGroup(input: AWS.QuickSight.CreateGroupRequest, options: SdkCallOptions): Promise; /** * Adds an Amazon QuickSight user to an Amazon QuickSight group. */ createGroupMembership(input: AWS.QuickSight.CreateGroupMembershipRequest, options: SdkCallOptions): Promise; /** * Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique. */ createIAMPolicyAssignment(input: AWS.QuickSight.CreateIAMPolicyAssignmentRequest, options: SdkCallOptions): Promise; /** * Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource. */ createIngestion(input: AWS.QuickSight.CreateIngestionRequest, options: SdkCallOptions): Promise; /** * (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support. */ createNamespace(input: AWS.QuickSight.CreateNamespaceRequest, options: SdkCallOptions): Promise; /** * Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template. */ createTemplate(input: AWS.QuickSight.CreateTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a template alias for a template. */ createTemplateAlias(input: AWS.QuickSight.CreateTemplateAliasRequest, options: SdkCallOptions): Promise; /** * Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide. */ createTheme(input: AWS.QuickSight.CreateThemeRequest, options: SdkCallOptions): Promise; /** * Creates a theme alias for a theme. */ createThemeAlias(input: AWS.QuickSight.CreateThemeAliasRequest, options: SdkCallOptions): Promise; /** * Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace. */ deleteAccountCustomization(input: AWS.QuickSight.DeleteAccountCustomizationRequest, options: SdkCallOptions): Promise; /** * Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it. */ deleteAnalysis(input: AWS.QuickSight.DeleteAnalysisRequest, options: SdkCallOptions): Promise; /** * Deletes a dashboard. */ deleteDashboard(input: AWS.QuickSight.DeleteDashboardRequest, options: SdkCallOptions): Promise; /** * Deletes a dataset. */ deleteDataSet(input: AWS.QuickSight.DeleteDataSetRequest, options: SdkCallOptions): Promise; /** * Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source. */ deleteDataSource(input: AWS.QuickSight.DeleteDataSourceRequest, options: SdkCallOptions): Promise; /** * Deletes an empty folder. */ deleteFolder(input: AWS.QuickSight.DeleteFolderRequest, options: SdkCallOptions): Promise; /** * Removes an asset, such as a dashboard, analysis, or dataset, from a folder. */ deleteFolderMembership(input: AWS.QuickSight.DeleteFolderMembershipRequest, options: SdkCallOptions): Promise; /** * Removes a user group from Amazon QuickSight. */ deleteGroup(input: AWS.QuickSight.DeleteGroupRequest, options: SdkCallOptions): Promise; /** * Removes a user from a group so that the user is no longer a member of the group. */ deleteGroupMembership(input: AWS.QuickSight.DeleteGroupMembershipRequest, options: SdkCallOptions): Promise; /** * Deletes an existing IAM policy assignment. */ deleteIAMPolicyAssignment(input: AWS.QuickSight.DeleteIAMPolicyAssignmentRequest, options: SdkCallOptions): Promise; /** * Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset. */ deleteNamespace(input: AWS.QuickSight.DeleteNamespaceRequest, options: SdkCallOptions): Promise; /** * Deletes a template. */ deleteTemplate(input: AWS.QuickSight.DeleteTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to. */ deleteTemplateAlias(input: AWS.QuickSight.DeleteTemplateAliasRequest, options: SdkCallOptions): Promise; /** * Deletes a theme. */ deleteTheme(input: AWS.QuickSight.DeleteThemeRequest, options: SdkCallOptions): Promise; /** * Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to. */ deleteThemeAlias(input: AWS.QuickSight.DeleteThemeAliasRequest, options: SdkCallOptions): Promise; /** * Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. */ deleteUser(input: AWS.QuickSight.DeleteUserRequest, options: SdkCallOptions): Promise; /** * Deletes a user identified by its principal ID. */ deleteUserByPrincipalId(input: AWS.QuickSight.DeleteUserByPrincipalIdRequest, options: SdkCallOptions): Promise; /** * Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region. Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI. Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region. Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations. */ describeAccountCustomization(input: AWS.QuickSight.DescribeAccountCustomizationRequest, options: SdkCallOptions): Promise; /** * Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account. */ describeAccountSettings(input: AWS.QuickSight.DescribeAccountSettingsRequest, options: SdkCallOptions): Promise; /** * Use the DescribeAccountSubscription operation to receive a description of a Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address. */ describeAccountSubscription(input: AWS.QuickSight.DescribeAccountSubscriptionRequest, options: SdkCallOptions): Promise; /** * Provides a summary of the metadata for an analysis. */ describeAnalysis(input: AWS.QuickSight.DescribeAnalysisRequest, options: SdkCallOptions): Promise; /** * Provides the read and write permissions for an analysis. */ describeAnalysisPermissions(input: AWS.QuickSight.DescribeAnalysisPermissionsRequest, options: SdkCallOptions): Promise; /** * Provides a summary for a dashboard. */ describeDashboard(input: AWS.QuickSight.DescribeDashboardRequest, options: SdkCallOptions): Promise; /** * Describes read and write permissions for a dashboard. */ describeDashboardPermissions(input: AWS.QuickSight.DescribeDashboardPermissionsRequest, options: SdkCallOptions): Promise; /** * Describes a dataset. This operation doesn't support datasets that include uploaded files as a source. */ describeDataSet(input: AWS.QuickSight.DescribeDataSetRequest, options: SdkCallOptions): Promise; /** * Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id. */ describeDataSetPermissions(input: AWS.QuickSight.DescribeDataSetPermissionsRequest, options: SdkCallOptions): Promise; /** * Describes a data source. */ describeDataSource(input: AWS.QuickSight.DescribeDataSourceRequest, options: SdkCallOptions): Promise; /** * Describes the resource permissions for a data source. */ describeDataSourcePermissions(input: AWS.QuickSight.DescribeDataSourcePermissionsRequest, options: SdkCallOptions): Promise; /** * Describes a folder. */ describeFolder(input: AWS.QuickSight.DescribeFolderRequest, options: SdkCallOptions): Promise; /** * Describes permissions for a folder. */ describeFolderPermissions(input: AWS.QuickSight.DescribeFolderPermissionsRequest, options: SdkCallOptions): Promise; /** * Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders. */ describeFolderResolvedPermissions(input: AWS.QuickSight.DescribeFolderResolvedPermissionsRequest, options: SdkCallOptions): Promise; /** * Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). */ describeGroup(input: AWS.QuickSight.DescribeGroupRequest, options: SdkCallOptions): Promise; /** * Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned. */ describeGroupMembership(input: AWS.QuickSight.DescribeGroupMembershipRequest, options: SdkCallOptions): Promise; /** * Describes an existing IAM policy assignment, as specified by the assignment name. */ describeIAMPolicyAssignment(input: AWS.QuickSight.DescribeIAMPolicyAssignmentRequest, options: SdkCallOptions): Promise; /** * Describes a SPICE ingestion. */ describeIngestion(input: AWS.QuickSight.DescribeIngestionRequest, options: SdkCallOptions): Promise; /** * Provides a summary and status of IP rules. */ describeIpRestriction(input: AWS.QuickSight.DescribeIpRestrictionRequest, options: SdkCallOptions): Promise; /** * Describes the current namespace. */ describeNamespace(input: AWS.QuickSight.DescribeNamespaceRequest, options: SdkCallOptions): Promise; /** * Describes a template's metadata. */ describeTemplate(input: AWS.QuickSight.DescribeTemplateRequest, options: SdkCallOptions): Promise; /** * Describes the template alias for a template. */ describeTemplateAlias(input: AWS.QuickSight.DescribeTemplateAliasRequest, options: SdkCallOptions): Promise; /** * Describes read and write permissions on a template. */ describeTemplatePermissions(input: AWS.QuickSight.DescribeTemplatePermissionsRequest, options: SdkCallOptions): Promise; /** * Describes a theme. */ describeTheme(input: AWS.QuickSight.DescribeThemeRequest, options: SdkCallOptions): Promise; /** * Describes the alias for a theme. */ describeThemeAlias(input: AWS.QuickSight.DescribeThemeAliasRequest, options: SdkCallOptions): Promise; /** * Describes the read and write permissions for a theme. */ describeThemePermissions(input: AWS.QuickSight.DescribeThemePermissionsRequest, options: SdkCallOptions): Promise; /** * Returns information about a user, given the user name. */ describeUser(input: AWS.QuickSight.DescribeUserRequest, options: SdkCallOptions): Promise; /** * Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal. */ generateEmbedUrlForAnonymousUser(input: AWS.QuickSight.GenerateEmbedUrlForAnonymousUserRequest, options: SdkCallOptions): Promise; /** * Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal. */ generateEmbedUrlForRegisteredUser(input: AWS.QuickSight.GenerateEmbedUrlForRegisteredUserRequest, options: SdkCallOptions): Promise; /** * Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. You are charged only when the URL is used or there is interaction with Amazon QuickSight. The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal. */ getDashboardEmbedUrl(input: AWS.QuickSight.GetDashboardEmbedUrlRequest, options: SdkCallOptions): Promise; /** * Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: Embedding Analytics Customizing Access to the Amazon QuickSight Console */ getSessionEmbedUrl(input: AWS.QuickSight.GetSessionEmbedUrlRequest, options: SdkCallOptions): Promise; /** * Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account. */ listAnalyses(input: AWS.QuickSight.ListAnalysesRequest, options: SdkCallOptions): Promise; /** * Lists all the versions of the dashboards in the Amazon QuickSight subscription. */ listDashboardVersions(input: AWS.QuickSight.ListDashboardVersionsRequest, options: SdkCallOptions): Promise; /** * Lists dashboards in an Amazon Web Services account. */ listDashboards(input: AWS.QuickSight.ListDashboardsRequest, options: SdkCallOptions): Promise; /** * Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*. */ listDataSets(input: AWS.QuickSight.ListDataSetsRequest, options: SdkCallOptions): Promise; /** * Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account. */ listDataSources(input: AWS.QuickSight.ListDataSourcesRequest, options: SdkCallOptions): Promise; /** * List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder. */ listFolderMembers(input: AWS.QuickSight.ListFolderMembersRequest, options: SdkCallOptions): Promise; /** * Lists all folders in an account. */ listFolders(input: AWS.QuickSight.ListFoldersRequest, options: SdkCallOptions): Promise; /** * Lists member users in a group. */ listGroupMemberships(input: AWS.QuickSight.ListGroupMembershipsRequest, options: SdkCallOptions): Promise; /** * Lists all user groups in Amazon QuickSight. */ listGroups(input: AWS.QuickSight.ListGroupsRequest, options: SdkCallOptions): Promise; /** * Lists IAM policy assignments in the current Amazon QuickSight account. */ listIAMPolicyAssignments(input: AWS.QuickSight.ListIAMPolicyAssignmentsRequest, options: SdkCallOptions): Promise; /** * Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to. */ listIAMPolicyAssignmentsForUser(input: AWS.QuickSight.ListIAMPolicyAssignmentsForUserRequest, options: SdkCallOptions): Promise; /** * Lists the history of SPICE ingestions for a dataset. */ listIngestions(input: AWS.QuickSight.ListIngestionsRequest, options: SdkCallOptions): Promise; /** * Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces. */ listNamespaces(input: AWS.QuickSight.ListNamespacesRequest, options: SdkCallOptions): Promise; /** * Lists the tags assigned to a resource. */ listTagsForResource(input: AWS.QuickSight.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists all the aliases of a template. */ listTemplateAliases(input: AWS.QuickSight.ListTemplateAliasesRequest, options: SdkCallOptions): Promise; /** * Lists all the versions of the templates in the current Amazon QuickSight account. */ listTemplateVersions(input: AWS.QuickSight.ListTemplateVersionsRequest, options: SdkCallOptions): Promise; /** * Lists all the templates in the current Amazon QuickSight account. */ listTemplates(input: AWS.QuickSight.ListTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists all the aliases of a theme. */ listThemeAliases(input: AWS.QuickSight.ListThemeAliasesRequest, options: SdkCallOptions): Promise; /** * Lists all the versions of the themes in the current Amazon Web Services account. */ listThemeVersions(input: AWS.QuickSight.ListThemeVersionsRequest, options: SdkCallOptions): Promise; /** * Lists all the themes in the current Amazon Web Services account. */ listThemes(input: AWS.QuickSight.ListThemesRequest, options: SdkCallOptions): Promise; /** * Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of. */ listUserGroups(input: AWS.QuickSight.ListUserGroupsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all of the Amazon QuickSight users belonging to this account. */ listUsers(input: AWS.QuickSight.ListUsersRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. */ registerUser(input: AWS.QuickSight.RegisterUserRequest, options: SdkCallOptions): Promise; /** * Restores an analysis. */ restoreAnalysis(input: AWS.QuickSight.RestoreAnalysisRequest, options: SdkCallOptions): Promise; /** * Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ searchAnalyses(input: AWS.QuickSight.SearchAnalysesRequest, options: SdkCallOptions): Promise; /** * Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ searchDashboards(input: AWS.QuickSight.SearchDashboardsRequest, options: SdkCallOptions): Promise; /** * Searches the subfolders in a folder. */ searchFolders(input: AWS.QuickSight.SearchFoldersRequest, options: SdkCallOptions): Promise; /** * Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters. */ searchGroups(input: AWS.QuickSight.SearchGroupsRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following: You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics. Amazon QuickSight doesn't currently support the tag editor for Resource Groups. */ tagResource(input: AWS.QuickSight.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag or tags from a resource. */ untagResource(input: AWS.QuickSight.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. */ updateAccountCustomization(input: AWS.QuickSight.UpdateAccountCustomizationRequest, options: SdkCallOptions): Promise; /** * Updates the Amazon QuickSight settings in your Amazon Web Services account. */ updateAccountSettings(input: AWS.QuickSight.UpdateAccountSettingsRequest, options: SdkCallOptions): Promise; /** * Updates an analysis in Amazon QuickSight */ updateAnalysis(input: AWS.QuickSight.UpdateAnalysisRequest, options: SdkCallOptions): Promise; /** * Updates the read and write permissions for an analysis. */ updateAnalysisPermissions(input: AWS.QuickSight.UpdateAnalysisPermissionsRequest, options: SdkCallOptions): Promise; /** * Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation. */ updateDashboard(input: AWS.QuickSight.UpdateDashboardRequest, options: SdkCallOptions): Promise; /** * Updates read and write permissions on a dashboard. */ updateDashboardPermissions(input: AWS.QuickSight.UpdateDashboardPermissionsRequest, options: SdkCallOptions): Promise; /** * Updates the published version of a dashboard. */ updateDashboardPublishedVersion(input: AWS.QuickSight.UpdateDashboardPublishedVersionRequest, options: SdkCallOptions): Promise; /** * Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. */ updateDataSet(input: AWS.QuickSight.UpdateDataSetRequest, options: SdkCallOptions): Promise; /** * Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id. */ updateDataSetPermissions(input: AWS.QuickSight.UpdateDataSetPermissionsRequest, options: SdkCallOptions): Promise; /** * Updates a data source. */ updateDataSource(input: AWS.QuickSight.UpdateDataSourceRequest, options: SdkCallOptions): Promise; /** * Updates the permissions to a data source. */ updateDataSourcePermissions(input: AWS.QuickSight.UpdateDataSourcePermissionsRequest, options: SdkCallOptions): Promise; /** * Updates the name of a folder. */ updateFolder(input: AWS.QuickSight.UpdateFolderRequest, options: SdkCallOptions): Promise; /** * Updates permissions of a folder. */ updateFolderPermissions(input: AWS.QuickSight.UpdateFolderPermissionsRequest, options: SdkCallOptions): Promise; /** * Changes a group description. */ updateGroup(input: AWS.QuickSight.UpdateGroupRequest, options: SdkCallOptions): Promise; /** * Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities. */ updateIAMPolicyAssignment(input: AWS.QuickSight.UpdateIAMPolicyAssignmentRequest, options: SdkCallOptions): Promise; /** * Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map. */ updateIpRestriction(input: AWS.QuickSight.UpdateIpRestrictionRequest, options: SdkCallOptions): Promise; /** * Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. To use this operation, turn on session capacity pricing for your Amazon QuickSight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide. */ updatePublicSharingSettings(input: AWS.QuickSight.UpdatePublicSharingSettingsRequest, options: SdkCallOptions): Promise; /** * Updates a template from an existing Amazon QuickSight analysis or another template. */ updateTemplate(input: AWS.QuickSight.UpdateTemplateRequest, options: SdkCallOptions): Promise; /** * Updates the template alias of a template. */ updateTemplateAlias(input: AWS.QuickSight.UpdateTemplateAliasRequest, options: SdkCallOptions): Promise; /** * Updates the resource permissions for a template. */ updateTemplatePermissions(input: AWS.QuickSight.UpdateTemplatePermissionsRequest, options: SdkCallOptions): Promise; /** * Updates a theme. */ updateTheme(input: AWS.QuickSight.UpdateThemeRequest, options: SdkCallOptions): Promise; /** * Updates an alias of a theme. */ updateThemeAlias(input: AWS.QuickSight.UpdateThemeAliasRequest, options: SdkCallOptions): Promise; /** * Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list. */ updateThemePermissions(input: AWS.QuickSight.UpdateThemePermissionsRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon QuickSight user. */ updateUser(input: AWS.QuickSight.UpdateUserRequest, options: SdkCallOptions): Promise; } export interface RAM { /** * Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools. */ acceptResourceShareInvitation(input: AWS.RAM.AcceptResourceShareInvitationRequest, options: SdkCallOptions): Promise; /** * Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share. */ associateResourceShare(input: AWS.RAM.AssociateResourceShareRequest, options: SdkCallOptions): Promise; /** * Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share. */ associateResourceSharePermission(input: AWS.RAM.AssociateResourceSharePermissionRequest, options: SdkCallOptions): Promise; /** * Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals. Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it. */ createResourceShare(input: AWS.RAM.CreateResourceShareRequest, options: SdkCallOptions): Promise; /** * Deletes the specified resource share. This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources outside of the Amazon Web Services account that created them. */ deleteResourceShare(input: AWS.RAM.DeleteResourceShareRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified principals or resources from the specified resource share. */ disassociateResourceShare(input: AWS.RAM.DisassociateResourceShareRequest, options: SdkCallOptions): Promise; /** * Disassociates an RAM permission from a resource share. Permission changes take effect immediately. You can remove a RAM permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share. */ disassociateResourceSharePermission(input: AWS.RAM.DisassociateResourceSharePermissionRequest, options: SdkCallOptions): Promise; /** * Enables resource sharing within your organization in Organizations. Calling this operation enables RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in an organization by specifying the organization's ID, or all of the accounts in an organizational unit (OU) by specifying the OU's ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM users and roles. You must call this operation from an IAM user or role in the organization's management account. */ enableSharingWithAwsOrganization(input: AWS.RAM.EnableSharingWithAwsOrganizationRequest, options: SdkCallOptions): Promise; /** * Gets the contents of an RAM permission in JSON format. */ getPermission(input: AWS.RAM.GetPermissionRequest, options: SdkCallOptions): Promise; /** * Retrieves the resource policies for the specified resources that you own and have shared. */ getResourcePolicies(input: AWS.RAM.GetResourcePoliciesRequest, options: SdkCallOptions): Promise; /** * Retrieves the resource and principal associations for resource shares that you own. */ getResourceShareAssociations(input: AWS.RAM.GetResourceShareAssociationsRequest, options: SdkCallOptions): Promise; /** * Retrieves details about invitations that you have received for resource shares. */ getResourceShareInvitations(input: AWS.RAM.GetResourceShareInvitationsRequest, options: SdkCallOptions): Promise; /** * Retrieves details about the resource shares that you own or that are shared with you. */ getResourceShares(input: AWS.RAM.GetResourceSharesRequest, options: SdkCallOptions): Promise; /** * Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired. */ listPendingInvitationResources(input: AWS.RAM.ListPendingInvitationResourcesRequest, options: SdkCallOptions): Promise; /** * Lists the available versions of the specified RAM permission. */ listPermissionVersions(input: AWS.RAM.ListPermissionVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of available RAM permissions that you can use for the supported resource types. */ listPermissions(input: AWS.RAM.ListPermissionsRequest, options: SdkCallOptions): Promise; /** * Lists the principals that you are sharing resources with or that are sharing resources with you. */ listPrincipals(input: AWS.RAM.ListPrincipalsRequest, options: SdkCallOptions): Promise; /** * Lists the RAM permissions that are associated with a resource share. */ listResourceSharePermissions(input: AWS.RAM.ListResourceSharePermissionsRequest, options: SdkCallOptions): Promise; /** * Lists the resource types that can be shared by RAM. */ listResourceTypes(input: AWS.RAM.ListResourceTypesRequest, options: SdkCallOptions): Promise; /** * Lists the resources that you added to a resource share or the resources that are shared with you. */ listResources(input: AWS.RAM.ListResourcesRequest, options: SdkCallOptions): Promise; /** * When you attach a resource-based permission policy to a resource, it automatically creates a resource share. However, resource shares created this way are visible only to the resource share owner, and the resource share can't be modified in RAM. You can use this operation to promote the resource share to a full RAM resource share. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with. */ promoteResourceShareCreatedFromPolicy(input: AWS.RAM.PromoteResourceShareCreatedFromPolicyRequest, options: SdkCallOptions): Promise; /** * Rejects an invitation to a resource share from another Amazon Web Services account. */ rejectResourceShareInvitation(input: AWS.RAM.RejectResourceShareInvitationRequest, options: SdkCallOptions): Promise; /** * Adds the specified tag keys and values to the specified resource share. The tags are attached only to the resource share, not to the resources that are in the resource share. */ tagResource(input: AWS.RAM.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tag key and value pairs from the specified resource share. */ untagResource(input: AWS.RAM.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Modifies some of the properties of the specified resource share. */ updateResourceShare(input: AWS.RAM.UpdateResourceShareRequest, options: SdkCallOptions): Promise; } export interface Rbin { /** * Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide. */ createRule(input: AWS.Rbin.CreateRuleRequest, options: SdkCallOptions): Promise; /** * Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide. */ deleteRule(input: AWS.Rbin.DeleteRuleRequest, options: SdkCallOptions): Promise; /** * Gets information about a Recycle Bin retention rule. */ getRule(input: AWS.Rbin.GetRuleRequest, options: SdkCallOptions): Promise; /** * Lists the Recycle Bin retention rules in the Region. */ listRules(input: AWS.Rbin.ListRulesRequest, options: SdkCallOptions): Promise; /** * Lists the tags assigned to a retention rule. */ listTagsForResource(input: AWS.Rbin.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Assigns tags to the specified retention rule. */ tagResource(input: AWS.Rbin.TagResourceRequest, options: SdkCallOptions): Promise; /** * Unassigns a tag from a retention rule. */ untagResource(input: AWS.Rbin.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing Recycle Bin retention rule. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide. */ updateRule(input: AWS.Rbin.UpdateRuleRequest, options: SdkCallOptions): Promise; } export interface RDS { /** * Associates an Identity and Access Management (IAM) role with a DB cluster. */ addRoleToDBCluster(input: AWS.RDS.AddRoleToDBClusterMessage, options: SdkCallOptions): Promise<{}>; /** * Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available. This command doesn't apply to RDS Custom. */ addRoleToDBInstance(input: AWS.RDS.AddRoleToDBInstanceMessage, options: SdkCallOptions): Promise<{}>; /** * Adds a source identifier to an existing RDS event notification subscription. */ addSourceIdentifierToSubscription(input: AWS.RDS.AddSourceIdentifierToSubscriptionMessage, options: SdkCallOptions): Promise; /** * Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources. */ addTagsToResource(input: AWS.RDS.AddTagsToResourceMessage, options: SdkCallOptions): Promise<{}>; /** * Applies a pending maintenance action to a resource (for example, to a DB instance). */ applyPendingMaintenanceAction(input: AWS.RDS.ApplyPendingMaintenanceActionMessage, options: SdkCallOptions): Promise; /** * Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial. EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide. */ authorizeDBSecurityGroupIngress(input: AWS.RDS.AuthorizeDBSecurityGroupIngressMessage, options: SdkCallOptions): Promise; /** * Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action applies only to Aurora MySQL DB clusters. */ backtrackDBCluster(input: AWS.RDS.BacktrackDBClusterMessage, options: SdkCallOptions): Promise; /** * Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed. */ cancelExportTask(input: AWS.RDS.CancelExportTaskMessage, options: SdkCallOptions): Promise; /** * Copies the specified DB cluster parameter group. */ copyDBClusterParameterGroup(input: AWS.RDS.CopyDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ copyDBClusterSnapshot(input: AWS.RDS.CopyDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Copies the specified DB parameter group. */ copyDBParameterGroup(input: AWS.RDS.CopyDBParameterGroupMessage, options: SdkCallOptions): Promise; /** * Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy. This command doesn't apply to RDS Custom. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide. */ copyDBSnapshot(input: AWS.RDS.CopyDBSnapshotMessage, options: SdkCallOptions): Promise; /** * Copies the specified option group. */ copyOptionGroup(input: AWS.RDS.CopyOptionGroupMessage, options: SdkCallOptions): Promise; /** * Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The supported engines are the following: Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3. When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM). Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed for custom engine version, and includes details about the failure. For example, the event prints missing files. After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the CreateCustomDbEngineVersion event. For more information, see Creating a CEV in the Amazon RDS User Guide. */ createCustomDBEngineVersion(input: AWS.RDS.CreateCustomDBEngineVersionMessage, options: SdkCallOptions): Promise; /** * Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ createDBCluster(input: AWS.RDS.CreateDBClusterMessage, options: SdkCallOptions): Promise; /** * Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action applies only to Aurora DB clusters. */ createDBClusterEndpoint(input: AWS.RDS.CreateDBClusterEndpointMessage, options: SdkCallOptions): Promise; /** * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ createDBClusterParameterGroup(input: AWS.RDS.CreateDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ createDBClusterSnapshot(input: AWS.RDS.CreateDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Creates a new DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster. For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide. For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide. */ createDBInstance(input: AWS.RDS.CreateDBInstanceMessage, options: SdkCallOptions): Promise; /** * Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster. All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified. Your source DB instance must have backup retention enabled. */ createDBInstanceReadReplica(input: AWS.RDS.CreateDBInstanceReadReplicaMessage, options: SdkCallOptions): Promise; /** * Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. This command doesn't apply to RDS Custom. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. */ createDBParameterGroup(input: AWS.RDS.CreateDBParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a new DB proxy. */ createDBProxy(input: AWS.RDS.CreateDBProxyRequest, options: SdkCallOptions): Promise; /** * Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC. */ createDBProxyEndpoint(input: AWS.RDS.CreateDBProxyEndpointRequest, options: SdkCallOptions): Promise; /** * Creates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are not in a VPC. EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide. */ createDBSecurityGroup(input: AWS.RDS.CreateDBSecurityGroupMessage, options: SdkCallOptions): Promise; /** * Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state. */ createDBSnapshot(input: AWS.RDS.CreateDBSnapshotMessage, options: SdkCallOptions): Promise; /** * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region. */ createDBSubnetGroup(input: AWS.RDS.CreateDBSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account. For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide. For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide. */ createEventSubscription(input: AWS.RDS.CreateEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action applies only to Aurora DB clusters. */ createGlobalCluster(input: AWS.RDS.CreateGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom. */ createOptionGroup(input: AWS.RDS.CreateOptionGroupMessage, options: SdkCallOptions): Promise; /** * Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon RDS User Guide. */ deleteCustomDBEngineVersion(input: AWS.RDS.DeleteCustomDBEngineVersionMessage, options: SdkCallOptions): Promise; /** * The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ deleteDBCluster(input: AWS.RDS.DeleteDBClusterMessage, options: SdkCallOptions): Promise; /** * Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. */ deleteDBClusterEndpoint(input: AWS.RDS.DeleteDBClusterEndpointMessage, options: SdkCallOptions): Promise; /** * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ deleteDBClusterParameterGroup(input: AWS.RDS.DeleteDBClusterParameterGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ deleteDBClusterSnapshot(input: AWS.RDS.DeleteDBClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter. If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true: The DB cluster is a read replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster. */ deleteDBInstance(input: AWS.RDS.DeleteDBInstanceMessage, options: SdkCallOptions): Promise; /** * Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups. */ deleteDBInstanceAutomatedBackup(input: AWS.RDS.DeleteDBInstanceAutomatedBackupMessage, options: SdkCallOptions): Promise; /** * Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances. */ deleteDBParameterGroup(input: AWS.RDS.DeleteDBParameterGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes an existing DB proxy. */ deleteDBProxy(input: AWS.RDS.DeleteDBProxyRequest, options: SdkCallOptions): Promise; /** * Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC. */ deleteDBProxyEndpoint(input: AWS.RDS.DeleteDBProxyEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes a DB security group. The specified DB security group must not be associated with any DB instances. EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide. */ deleteDBSecurityGroup(input: AWS.RDS.DeleteDBSecurityGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted. */ deleteDBSnapshot(input: AWS.RDS.DeleteDBSnapshotMessage, options: SdkCallOptions): Promise; /** * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. */ deleteDBSubnetGroup(input: AWS.RDS.DeleteDBSubnetGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes an RDS event notification subscription. */ deleteEventSubscription(input: AWS.RDS.DeleteEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters. */ deleteGlobalCluster(input: AWS.RDS.DeleteGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Deletes an existing option group. */ deleteOptionGroup(input: AWS.RDS.DeleteOptionGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup. */ deregisterDBProxyTargets(input: AWS.RDS.DeregisterDBProxyTargetsRequest, options: SdkCallOptions): Promise; /** * Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command doesn't take any parameters. */ describeAccountAttributes(input: AWS.RDS.DescribeAccountAttributesMessage, options: SdkCallOptions): Promise; /** * Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account. */ describeCertificates(input: AWS.RDS.DescribeCertificatesMessage, options: SdkCallOptions): Promise; /** * Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB clusters. */ describeDBClusterBacktracks(input: AWS.RDS.DescribeDBClusterBacktracksMessage, options: SdkCallOptions): Promise; /** * Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. */ describeDBClusterEndpoints(input: AWS.RDS.DescribeDBClusterEndpointsMessage, options: SdkCallOptions): Promise; /** * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ describeDBClusterParameterGroups(input: AWS.RDS.DescribeDBClusterParameterGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ describeDBClusterParameters(input: AWS.RDS.DescribeDBClusterParametersMessage, options: SdkCallOptions): Promise; /** * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts. To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action. */ describeDBClusterSnapshotAttributes(input: AWS.RDS.DescribeDBClusterSnapshotAttributesMessage, options: SdkCallOptions): Promise; /** * Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ describeDBClusterSnapshots(input: AWS.RDS.DescribeDBClusterSnapshotsMessage, options: SdkCallOptions): Promise; /** * Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances. */ describeDBClusters(input: AWS.RDS.DescribeDBClustersMessage, options: SdkCallOptions): Promise; /** * Returns a list of the available DB engines. */ describeDBEngineVersions(input: AWS.RDS.DescribeDBEngineVersionsMessage, options: SdkCallOptions): Promise; /** * Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations. All parameters are optional. */ describeDBInstanceAutomatedBackups(input: AWS.RDS.DescribeDBInstanceAutomatedBackupsMessage, options: SdkCallOptions): Promise; /** * Returns information about provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances. */ describeDBInstances(input: AWS.RDS.DescribeDBInstancesMessage, options: SdkCallOptions): Promise; /** * Returns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom. */ describeDBLogFiles(input: AWS.RDS.DescribeDBLogFilesMessage, options: SdkCallOptions): Promise; /** * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group. */ describeDBParameterGroups(input: AWS.RDS.DescribeDBParameterGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the detailed parameter list for a particular DB parameter group. */ describeDBParameters(input: AWS.RDS.DescribeDBParametersMessage, options: SdkCallOptions): Promise; /** * Returns information about DB proxies. */ describeDBProxies(input: AWS.RDS.DescribeDBProxiesRequest, options: SdkCallOptions): Promise; /** * Returns information about DB proxy endpoints. */ describeDBProxyEndpoints(input: AWS.RDS.DescribeDBProxyEndpointsRequest, options: SdkCallOptions): Promise; /** * Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures. */ describeDBProxyTargetGroups(input: AWS.RDS.DescribeDBProxyTargetGroupsRequest, options: SdkCallOptions): Promise; /** * Returns information about DBProxyTarget objects. This API supports pagination. */ describeDBProxyTargets(input: AWS.RDS.DescribeDBProxyTargetsRequest, options: SdkCallOptions): Promise; /** * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group. EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide. */ describeDBSecurityGroups(input: AWS.RDS.DescribeDBSecurityGroupsMessage, options: SdkCallOptions): Promise; /** * Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts. To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action. */ describeDBSnapshotAttributes(input: AWS.RDS.DescribeDBSnapshotAttributesMessage, options: SdkCallOptions): Promise; /** * Returns information about DB snapshots. This API action supports pagination. */ describeDBSnapshots(input: AWS.RDS.DescribeDBSnapshotsMessage, options: SdkCallOptions): Promise; /** * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. */ describeDBSubnetGroups(input: AWS.RDS.DescribeDBSubnetGroupsMessage, options: SdkCallOptions): Promise; /** * Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. */ describeEngineDefaultClusterParameters(input: AWS.RDS.DescribeEngineDefaultClusterParametersMessage, options: SdkCallOptions): Promise; /** * Returns the default engine and system parameter information for the specified database engine. */ describeEngineDefaultParameters(input: AWS.RDS.DescribeEngineDefaultParametersMessage, options: SdkCallOptions): Promise; /** * Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . */ describeEventCategories(input: AWS.RDS.DescribeEventCategoriesMessage, options: SdkCallOptions): Promise; /** * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. */ describeEventSubscriptions(input: AWS.RDS.DescribeEventSubscriptionsMessage, options: SdkCallOptions): Promise; /** * Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter. For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide. By default, RDS returns events that were generated in the past hour. */ describeEvents(input: AWS.RDS.DescribeEventsMessage, options: SdkCallOptions): Promise; /** * Returns information about a snapshot export to Amazon S3. This API operation supports pagination. */ describeExportTasks(input: AWS.RDS.DescribeExportTasksMessage, options: SdkCallOptions): Promise; /** * Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. */ describeGlobalClusters(input: AWS.RDS.DescribeGlobalClustersMessage, options: SdkCallOptions): Promise; /** * Describes all available options. */ describeOptionGroupOptions(input: AWS.RDS.DescribeOptionGroupOptionsMessage, options: SdkCallOptions): Promise; /** * Describes the available option groups. */ describeOptionGroups(input: AWS.RDS.DescribeOptionGroupsMessage, options: SdkCallOptions): Promise; /** * Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class. */ describeOrderableDBInstanceOptions(input: AWS.RDS.DescribeOrderableDBInstanceOptionsMessage, options: SdkCallOptions): Promise; /** * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. */ describePendingMaintenanceActions(input: AWS.RDS.DescribePendingMaintenanceActionsMessage, options: SdkCallOptions): Promise; /** * Returns information about reserved DB instances for this account, or about a specified reserved DB instance. */ describeReservedDBInstances(input: AWS.RDS.DescribeReservedDBInstancesMessage, options: SdkCallOptions): Promise; /** * Lists available reserved DB instance offerings. */ describeReservedDBInstancesOfferings(input: AWS.RDS.DescribeReservedDBInstancesOfferingsMessage, options: SdkCallOptions): Promise; /** * Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination. To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference. */ describeSourceRegions(input: AWS.RDS.DescribeSourceRegionsMessage, options: SdkCallOptions): Promise; /** * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. This command doesn't apply to RDS Custom. */ describeValidDBInstanceModifications(input: AWS.RDS.DescribeValidDBInstanceModificationsMessage, options: SdkCallOptions): Promise; /** * Downloads all or a portion of the specified log file, up to 1 MB in size. This command doesn't apply to RDS Custom. */ downloadDBLogFilePortion(input: AWS.RDS.DownloadDBLogFilePortionMessage, options: SdkCallOptions): Promise; /** * Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails. To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ failoverDBCluster(input: AWS.RDS.FailoverDBClusterMessage, options: SdkCallOptions): Promise; /** * Initiates the failover process for an Aurora global database (GlobalCluster). A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database. For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide. This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology. */ failoverGlobalCluster(input: AWS.RDS.FailoverGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. */ listTagsForResource(input: AWS.RDS.ListTagsForResourceMessage, options: SdkCallOptions): Promise; /** * Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide. This operation is supported for RDS for Oracle only. */ modifyActivityStream(input: AWS.RDS.ModifyActivityStreamRequest, options: SdkCallOptions): Promise; /** * Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override. By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS. You might need to override the default certificate in the following situations: You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region. RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes. For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. */ modifyCertificates(input: AWS.RDS.ModifyCertificatesMessage, options: SdkCallOptions): Promise; /** * Set the capacity of an Aurora Serverless v1 DB cluster to a specific value. Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. This action only applies to Aurora Serverless v1 DB clusters. */ modifyCurrentDBClusterCapacity(input: AWS.RDS.ModifyCurrentDBClusterCapacityMessage, options: SdkCallOptions): Promise; /** * Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the Amazon RDS User Guide. */ modifyCustomDBEngineVersion(input: AWS.RDS.ModifyCustomDBEngineVersionMessage, options: SdkCallOptions): Promise; /** * Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ modifyDBCluster(input: AWS.RDS.ModifyDBClusterMessage, options: SdkCallOptions): Promise; /** * Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters. */ modifyDBClusterEndpoint(input: AWS.RDS.ModifyDBClusterEndpointMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ modifyDBClusterParameterGroup(input: AWS.RDS.ModifyDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute. */ modifyDBClusterSnapshotAttribute(input: AWS.RDS.ModifyDBClusterSnapshotAttributeMessage, options: SdkCallOptions): Promise; /** * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance. */ modifyDBInstance(input: AWS.RDS.ModifyDBInstanceMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified. */ modifyDBParameterGroup(input: AWS.RDS.ModifyDBParameterGroupMessage, options: SdkCallOptions): Promise; /** * Changes the settings for an existing DB proxy. */ modifyDBProxy(input: AWS.RDS.ModifyDBProxyRequest, options: SdkCallOptions): Promise; /** * Changes the settings for an existing DB proxy endpoint. */ modifyDBProxyEndpoint(input: AWS.RDS.ModifyDBProxyEndpointRequest, options: SdkCallOptions): Promise; /** * Modifies the properties of a DBProxyTargetGroup. */ modifyDBProxyTargetGroup(input: AWS.RDS.ModifyDBProxyTargetGroupRequest, options: SdkCallOptions): Promise; /** * Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom. */ modifyDBSnapshot(input: AWS.RDS.ModifyDBSnapshotMessage, options: SdkCallOptions): Promise; /** * Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute. */ modifyDBSnapshotAttribute(input: AWS.RDS.ModifyDBSnapshotAttributeMessage, options: SdkCallOptions): Promise; /** * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region. */ modifyDBSubnetGroup(input: AWS.RDS.ModifyDBSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation. */ modifyEventSubscription(input: AWS.RDS.ModifyEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. */ modifyGlobalCluster(input: AWS.RDS.ModifyGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Modifies an existing option group. */ modifyOptionGroup(input: AWS.RDS.ModifyOptionGroupMessage, options: SdkCallOptions): Promise; /** * Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom. */ promoteReadReplica(input: AWS.RDS.PromoteReadReplicaMessage, options: SdkCallOptions): Promise; /** * Promotes a read replica DB cluster to a standalone DB cluster. */ promoteReadReplicaDBCluster(input: AWS.RDS.PromoteReadReplicaDBClusterMessage, options: SdkCallOptions): Promise; /** * Purchases a reserved DB instance offering. */ purchaseReservedDBInstancesOffering(input: AWS.RDS.PurchaseReservedDBInstancesOfferingMessage, options: SdkCallOptions): Promise; /** * You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect. Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting. Use this operation only for a non-Aurora Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ rebootDBCluster(input: AWS.RDS.RebootDBClusterMessage, options: SdkCallOptions): Promise; /** * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom. If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation. */ rebootDBInstance(input: AWS.RDS.RebootDBInstanceMessage, options: SdkCallOptions): Promise; /** * Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup. */ registerDBProxyTargets(input: AWS.RDS.RegisterDBProxyTargetsRequest, options: SdkCallOptions): Promise; /** * Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region. This action only applies to Aurora DB clusters. */ removeFromGlobalCluster(input: AWS.RDS.RemoveFromGlobalClusterMessage, options: SdkCallOptions): Promise; /** * Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ removeRoleFromDBCluster(input: AWS.RDS.RemoveRoleFromDBClusterMessage, options: SdkCallOptions): Promise<{}>; /** * Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance. */ removeRoleFromDBInstance(input: AWS.RDS.RemoveRoleFromDBInstanceMessage, options: SdkCallOptions): Promise<{}>; /** * Removes a source identifier from an existing RDS event notification subscription. */ removeSourceIdentifierFromSubscription(input: AWS.RDS.RemoveSourceIdentifierFromSubscriptionMessage, options: SdkCallOptions): Promise; /** * Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. */ removeTagsFromResource(input: AWS.RDS.RemoveTagsFromResourceMessage, options: SdkCallOptions): Promise<{}>; /** * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ resetDBClusterParameterGroup(input: AWS.RDS.ResetDBClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. */ resetDBParameterGroup(input: AWS.RDS.ResetDBParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. The source DB engine must be MySQL. */ restoreDBClusterFromS3(input: AWS.RDS.RestoreDBClusterFromS3Message, options: SdkCallOptions): Promise; /** * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ restoreDBClusterFromSnapshot(input: AWS.RDS.RestoreDBClusterFromSnapshotMessage, options: SdkCallOptions): Promise; /** * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. */ restoreDBClusterToPointInTime(input: AWS.RDS.RestoreDBClusterToPointInTimeMessage, options: SdkCallOptions): Promise; /** * Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment. If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot. */ restoreDBInstanceFromDBSnapshot(input: AWS.RDS.RestoreDBInstanceFromDBSnapshotMessage, options: SdkCallOptions): Promise; /** * Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom. */ restoreDBInstanceFromS3(input: AWS.RDS.RestoreDBInstanceFromS3Message, options: SdkCallOptions): Promise; /** * Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime. */ restoreDBInstanceToPointInTime(input: AWS.RDS.RestoreDBInstanceToPointInTimeMessage, options: SdkCallOptions): Promise; /** * Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide. */ revokeDBSecurityGroupIngress(input: AWS.RDS.RevokeDBSecurityGroupIngressMessage, options: SdkCallOptions): Promise; /** * Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide. */ startActivityStream(input: AWS.RDS.StartActivityStreamRequest, options: SdkCallOptions): Promise; /** * Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. */ startDBCluster(input: AWS.RDS.StartDBClusterMessage, options: SdkCallOptions): Promise; /** * Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead. */ startDBInstance(input: AWS.RDS.StartDBInstanceMessage, options: SdkCallOptions): Promise; /** * Enables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide. */ startDBInstanceAutomatedBackupsReplication(input: AWS.RDS.StartDBInstanceAutomatedBackupsReplicationMessage, options: SdkCallOptions): Promise; /** * Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket. This command doesn't apply to RDS Custom. */ startExportTask(input: AWS.RDS.StartExportTaskMessage, options: SdkCallOptions): Promise; /** * Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action. For more information, see Database Activity Streams in the Amazon Aurora User Guide. */ stopActivityStream(input: AWS.RDS.StopActivityStreamRequest, options: SdkCallOptions): Promise; /** * Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. */ stopDBCluster(input: AWS.RDS.StopDBClusterMessage, options: SdkCallOptions): Promise; /** * Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead. */ stopDBInstance(input: AWS.RDS.StopDBInstanceMessage, options: SdkCallOptions): Promise; /** * Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide. */ stopDBInstanceAutomatedBackupsReplication(input: AWS.RDS.StopDBInstanceAutomatedBackupsReplicationMessage, options: SdkCallOptions): Promise; /** * Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database. */ switchoverReadReplica(input: AWS.RDS.SwitchoverReadReplicaMessage, options: SdkCallOptions): Promise; } export interface RDSDataService { /** * Runs a batch SQL statement over an array of data. You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set. The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated. */ batchExecuteStatement(input: AWS.RDSDataService.BatchExecuteStatementRequest, options: SdkCallOptions): Promise; /** * Starts a SQL transaction. A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours. A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically. DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled. */ beginTransaction(input: AWS.RDSDataService.BeginTransactionRequest, options: SdkCallOptions): Promise; /** * Ends a SQL transaction started with the BeginTransaction operation and commits the changes. */ commitTransaction(input: AWS.RDSDataService.CommitTransactionRequest, options: SdkCallOptions): Promise; /** * Runs one or more SQL statements. This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation. */ executeSql(input: AWS.RDSDataService.ExecuteSqlRequest, options: SdkCallOptions): Promise; /** * Runs a SQL statement against a database. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. If the binary response data from the database is more than 1 MB, the call is terminated. */ executeStatement(input: AWS.RDSDataService.ExecuteStatementRequest, options: SdkCallOptions): Promise; /** * Performs a rollback of a transaction. Rolling back a transaction cancels its changes. */ rollbackTransaction(input: AWS.RDSDataService.RollbackTransactionRequest, options: SdkCallOptions): Promise; } export interface Redshift { /** * Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs. */ acceptReservedNodeExchange(input: AWS.Redshift.AcceptReservedNodeExchangeInputMessage, options: SdkCallOptions): Promise; /** * Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website. */ addPartner(input: AWS.Redshift.PartnerIntegrationInputMessage, options: SdkCallOptions): Promise; /** * From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare. */ associateDataShareConsumer(input: AWS.Redshift.AssociateDataShareConsumerMessage, options: SdkCallOptions): Promise; /** * Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same Amazon Web Services Region. If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing. You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide. */ authorizeClusterSecurityGroupIngress(input: AWS.Redshift.AuthorizeClusterSecurityGroupIngressMessage, options: SdkCallOptions): Promise; /** * From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions. */ authorizeDataShare(input: AWS.Redshift.AuthorizeDataShareMessage, options: SdkCallOptions): Promise; /** * Grants access to a cluster. */ authorizeEndpointAccess(input: AWS.Redshift.AuthorizeEndpointAccessMessage, options: SdkCallOptions): Promise; /** * Authorizes the specified Amazon Web Services account to restore the specified snapshot. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. */ authorizeSnapshotAccess(input: AWS.Redshift.AuthorizeSnapshotAccessMessage, options: SdkCallOptions): Promise; /** * Deletes a set of cluster snapshots. */ batchDeleteClusterSnapshots(input: AWS.Redshift.BatchDeleteClusterSnapshotsRequest, options: SdkCallOptions): Promise; /** * Modifies the settings for a set of cluster snapshots. */ batchModifyClusterSnapshots(input: AWS.Redshift.BatchModifyClusterSnapshotsMessage, options: SdkCallOptions): Promise; /** * Cancels a resize operation for a cluster. */ cancelResize(input: AWS.Redshift.CancelResizeMessage, options: SdkCallOptions): Promise; /** * Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. */ copyClusterSnapshot(input: AWS.Redshift.CopyClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Creates an authentication profile with the specified parameters. */ createAuthenticationProfile(input: AWS.Redshift.CreateAuthenticationProfileMessage, options: SdkCallOptions): Promise; /** * Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. */ createCluster(input: AWS.Redshift.CreateClusterMessage, options: SdkCallOptions): Promise; /** * Creates an Amazon Redshift parameter group. Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster. Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. */ createClusterParameterGroup(input: AWS.Redshift.CreateClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. */ createClusterSecurityGroup(input: AWS.Redshift.CreateClusterSecurityGroupMessage, options: SdkCallOptions): Promise; /** * Creates a manual snapshot of the specified cluster. The cluster must be in the available state. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. */ createClusterSnapshot(input: AWS.Redshift.CreateClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide. */ createClusterSubnetGroup(input: AWS.Redshift.CreateClusterSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Creates a Redshift-managed VPC endpoint. */ createEndpointAccess(input: AWS.Redshift.CreateEndpointAccessMessage, options: SdkCallOptions): Promise; /** * Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your Amazon Web Services account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your Amazon Web Services account. You must specify a source type if you specify a source ID. */ createEventSubscription(input: AWS.Redshift.CreateEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide. */ createHsmClientCertificate(input: AWS.Redshift.CreateHsmClientCertificateMessage, options: SdkCallOptions): Promise; /** * Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide. */ createHsmConfiguration(input: AWS.Redshift.CreateHsmConfigurationMessage, options: SdkCallOptions): Promise; /** * Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation. */ createScheduledAction(input: AWS.Redshift.CreateScheduledActionMessage, options: SdkCallOptions): Promise; /** * Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide. */ createSnapshotCopyGrant(input: AWS.Redshift.CreateSnapshotCopyGrantMessage, options: SdkCallOptions): Promise; /** * Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule. */ createSnapshotSchedule(input: AWS.Redshift.CreateSnapshotScheduleMessage, options: SdkCallOptions): Promise; /** * Adds tags to a cluster. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail. If you specify a key that already exists for the resource, the value for that key will be updated with the new value. */ createTags(input: AWS.Redshift.CreateTagsMessage, options: SdkCallOptions): Promise<{}>; /** * Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier. */ createUsageLimit(input: AWS.Redshift.CreateUsageLimitMessage, options: SdkCallOptions): Promise; /** * From a datashare producer account, removes authorization from the specified datashare. */ deauthorizeDataShare(input: AWS.Redshift.DeauthorizeDataShareMessage, options: SdkCallOptions): Promise; /** * Deletes an authentication profile. */ deleteAuthenticationProfile(input: AWS.Redshift.DeleteAuthenticationProfileMessage, options: SdkCallOptions): Promise; /** * Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. */ deleteCluster(input: AWS.Redshift.DeleteClusterMessage, options: SdkCallOptions): Promise; /** * Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster. */ deleteClusterParameterGroup(input: AWS.Redshift.DeleteClusterParameterGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. */ deleteClusterSecurityGroup(input: AWS.Redshift.DeleteClusterSecurityGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot. Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot. */ deleteClusterSnapshot(input: AWS.Redshift.DeleteClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Deletes the specified cluster subnet group. */ deleteClusterSubnetGroup(input: AWS.Redshift.DeleteClusterSubnetGroupMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a Redshift-managed VPC endpoint. */ deleteEndpointAccess(input: AWS.Redshift.DeleteEndpointAccessMessage, options: SdkCallOptions): Promise; /** * Deletes an Amazon Redshift event notification subscription. */ deleteEventSubscription(input: AWS.Redshift.DeleteEventSubscriptionMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified HSM client certificate. */ deleteHsmClientCertificate(input: AWS.Redshift.DeleteHsmClientCertificateMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Amazon Redshift HSM configuration. */ deleteHsmConfiguration(input: AWS.Redshift.DeleteHsmConfigurationMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website. */ deletePartner(input: AWS.Redshift.PartnerIntegrationInputMessage, options: SdkCallOptions): Promise; /** * Deletes a scheduled action. */ deleteScheduledAction(input: AWS.Redshift.DeleteScheduledActionMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified snapshot copy grant. */ deleteSnapshotCopyGrant(input: AWS.Redshift.DeleteSnapshotCopyGrantMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a snapshot schedule. */ deleteSnapshotSchedule(input: AWS.Redshift.DeleteSnapshotScheduleMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. */ deleteTags(input: AWS.Redshift.DeleteTagsMessage, options: SdkCallOptions): Promise<{}>; /** * Deletes a usage limit from a cluster. */ deleteUsageLimit(input: AWS.Redshift.DeleteUsageLimitMessage, options: SdkCallOptions): Promise<{}>; /** * Returns a list of attributes attached to an account */ describeAccountAttributes(input: AWS.Redshift.DescribeAccountAttributesMessage, options: SdkCallOptions): Promise; /** * Describes an authentication profile. */ describeAuthenticationProfiles(input: AWS.Redshift.DescribeAuthenticationProfilesMessage, options: SdkCallOptions): Promise; /** * Returns an array of ClusterDbRevision objects. */ describeClusterDbRevisions(input: AWS.Redshift.DescribeClusterDbRevisionsMessage, options: SdkCallOptions): Promise; /** * Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. */ describeClusterParameterGroups(input: AWS.Redshift.DescribeClusterParameterGroupsMessage, options: SdkCallOptions): Promise; /** * Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. */ describeClusterParameters(input: AWS.Redshift.DescribeClusterParametersMessage, options: SdkCallOptions): Promise; /** * Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. */ describeClusterSecurityGroups(input: AWS.Redshift.DescribeClusterSecurityGroupsMessage, options: SdkCallOptions): Promise; /** * Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. */ describeClusterSnapshots(input: AWS.Redshift.DescribeClusterSnapshotsMessage, options: SdkCallOptions): Promise; /** * Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. */ describeClusterSubnetGroups(input: AWS.Redshift.DescribeClusterSubnetGroupsMessage, options: SdkCallOptions): Promise; /** * Returns a list of all the available maintenance tracks. */ describeClusterTracks(input: AWS.Redshift.DescribeClusterTracksMessage, options: SdkCallOptions): Promise; /** * Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. */ describeClusterVersions(input: AWS.Redshift.DescribeClusterVersionsMessage, options: SdkCallOptions): Promise; /** * Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned. If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. */ describeClusters(input: AWS.Redshift.DescribeClustersMessage, options: SdkCallOptions): Promise; /** * Shows the status of any inbound or outbound datashares available in the specified account. */ describeDataShares(input: AWS.Redshift.DescribeDataSharesMessage, options: SdkCallOptions): Promise; /** * Returns a list of datashares where the account identifier being called is a consumer account identifier. */ describeDataSharesForConsumer(input: AWS.Redshift.DescribeDataSharesForConsumerMessage, options: SdkCallOptions): Promise; /** * Returns a list of datashares when the account identifier being called is a producer account identifier. */ describeDataSharesForProducer(input: AWS.Redshift.DescribeDataSharesForProducerMessage, options: SdkCallOptions): Promise; /** * Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. */ describeDefaultClusterParameters(input: AWS.Redshift.DescribeDefaultClusterParametersMessage, options: SdkCallOptions): Promise; /** * Describes a Redshift-managed VPC endpoint. */ describeEndpointAccess(input: AWS.Redshift.DescribeEndpointAccessMessage, options: SdkCallOptions): Promise; /** * Describes an endpoint authorization. */ describeEndpointAuthorization(input: AWS.Redshift.DescribeEndpointAuthorizationMessage, options: SdkCallOptions): Promise; /** * Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications. */ describeEventCategories(input: AWS.Redshift.DescribeEventCategoriesMessage, options: SdkCallOptions): Promise; /** * Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned. If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them. */ describeEventSubscriptions(input: AWS.Redshift.DescribeEventSubscriptionsMessage, options: SdkCallOptions): Promise; /** * Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. */ describeEvents(input: AWS.Redshift.DescribeEventsMessage, options: SdkCallOptions): Promise; /** * Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. */ describeHsmClientCertificates(input: AWS.Redshift.DescribeHsmClientCertificatesMessage, options: SdkCallOptions): Promise; /** * Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. */ describeHsmConfigurations(input: AWS.Redshift.DescribeHsmConfigurationsMessage, options: SdkCallOptions): Promise; /** * Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. */ describeLoggingStatus(input: AWS.Redshift.DescribeLoggingStatusMessage, options: SdkCallOptions): Promise; /** * Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type. */ describeNodeConfigurationOptions(input: AWS.Redshift.DescribeNodeConfigurationOptionsMessage, options: SdkCallOptions): Promise; /** * Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. */ describeOrderableClusterOptions(input: AWS.Redshift.DescribeOrderableClusterOptionsMessage, options: SdkCallOptions): Promise; /** * Returns information about the partner integrations defined for a cluster. */ describePartners(input: AWS.Redshift.DescribePartnersInputMessage, options: SdkCallOptions): Promise; /** * Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested. */ describeReservedNodeExchangeStatus(input: AWS.Redshift.DescribeReservedNodeExchangeStatusInputMessage, options: SdkCallOptions): Promise; /** * Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. */ describeReservedNodeOfferings(input: AWS.Redshift.DescribeReservedNodeOfferingsMessage, options: SdkCallOptions): Promise; /** * Returns the descriptions of the reserved nodes. */ describeReservedNodes(input: AWS.Redshift.DescribeReservedNodesMessage, options: SdkCallOptions): Promise; /** * Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize. A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster. */ describeResize(input: AWS.Redshift.DescribeResizeMessage, options: SdkCallOptions): Promise; /** * Describes properties of scheduled actions. */ describeScheduledActions(input: AWS.Redshift.DescribeScheduledActionsMessage, options: SdkCallOptions): Promise; /** * Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide. */ describeSnapshotCopyGrants(input: AWS.Redshift.DescribeSnapshotCopyGrantsMessage, options: SdkCallOptions): Promise; /** * Returns a list of snapshot schedules. */ describeSnapshotSchedules(input: AWS.Redshift.DescribeSnapshotSchedulesMessage, options: SdkCallOptions): Promise; /** * Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId. */ describeTableRestoreStatus(input: AWS.Redshift.DescribeTableRestoreStatusMessage, options: SdkCallOptions): Promise; /** * Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. The following are limitations for DescribeTags: You cannot specify an ARN and a resource-type value together in the same request. You cannot use the MaxRecords and Marker parameters together with the ARN parameter. The MaxRecords parameter can be a range from 10 to 50 results to return in a request. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned. If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them. */ describeTags(input: AWS.Redshift.DescribeTagsMessage, options: SdkCallOptions): Promise; /** * Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters: If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned. If usage limit identifier is provided, then the corresponding usage limit object is returned. If cluster identifier is provided, then all usage limit objects for the specified cluster are returned. If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned. */ describeUsageLimits(input: AWS.Redshift.DescribeUsageLimitsMessage, options: SdkCallOptions): Promise; /** * Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. */ disableLogging(input: AWS.Redshift.DisableLoggingMessage, options: SdkCallOptions): Promise; /** * Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using an encrypted symmetric key from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the key in the destination region. */ disableSnapshotCopy(input: AWS.Redshift.DisableSnapshotCopyMessage, options: SdkCallOptions): Promise; /** * From a datashare consumer account, remove association for the specified datashare. */ disassociateDataShareConsumer(input: AWS.Redshift.DisassociateDataShareConsumerMessage, options: SdkCallOptions): Promise; /** * Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. */ enableLogging(input: AWS.Redshift.EnableLoggingMessage, options: SdkCallOptions): Promise; /** * Enables the automatic copy of snapshots from one region to another region for a specified cluster. */ enableSnapshotCopy(input: AWS.Redshift.EnableSnapshotCopyMessage, options: SdkCallOptions): Promise; /** * Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide. The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser permission. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name. */ getClusterCredentials(input: AWS.Redshift.GetClusterCredentialsMessage, options: SdkCallOptions): Promise; /** * Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity. For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the Amazon Web Services Identity and Access Management User Guide. The Identity and Access Management (IAM) identity that runs this operation must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Using identity-based policies (IAM policies) in the Amazon Redshift Cluster Management Guide. */ getClusterCredentialsWithIAM(input: AWS.Redshift.GetClusterCredentialsWithIAMMessage, options: SdkCallOptions): Promise; /** * Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type. */ getReservedNodeExchangeConfigurationOptions(input: AWS.Redshift.GetReservedNodeExchangeConfigurationOptionsInputMessage, options: SdkCallOptions): Promise; /** * Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node. */ getReservedNodeExchangeOfferings(input: AWS.Redshift.GetReservedNodeExchangeOfferingsInputMessage, options: SdkCallOptions): Promise; /** * This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). */ modifyAquaConfiguration(input: AWS.Redshift.ModifyAquaInputMessage, options: SdkCallOptions): Promise; /** * Modifies an authentication profile. */ modifyAuthenticationProfile(input: AWS.Redshift.ModifyAuthenticationProfileMessage, options: SdkCallOptions): Promise; /** * Modifies the settings for a cluster. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. */ modifyCluster(input: AWS.Redshift.ModifyClusterMessage, options: SdkCallOptions): Promise; /** * Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster. */ modifyClusterDbRevision(input: AWS.Redshift.ModifyClusterDbRevisionMessage, options: SdkCallOptions): Promise; /** * Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide. */ modifyClusterIamRoles(input: AWS.Redshift.ModifyClusterIamRolesMessage, options: SdkCallOptions): Promise; /** * Modifies the maintenance settings of a cluster. */ modifyClusterMaintenance(input: AWS.Redshift.ModifyClusterMaintenanceMessage, options: SdkCallOptions): Promise; /** * Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. */ modifyClusterParameterGroup(input: AWS.Redshift.ModifyClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Modifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a cluster snapshot. */ modifyClusterSnapshot(input: AWS.Redshift.ModifyClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Modifies a snapshot schedule for a cluster. */ modifyClusterSnapshotSchedule(input: AWS.Redshift.ModifyClusterSnapshotScheduleMessage, options: SdkCallOptions): Promise<{}>; /** * Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets. */ modifyClusterSubnetGroup(input: AWS.Redshift.ModifyClusterSubnetGroupMessage, options: SdkCallOptions): Promise; /** * Modifies a Redshift-managed VPC endpoint. */ modifyEndpointAccess(input: AWS.Redshift.ModifyEndpointAccessMessage, options: SdkCallOptions): Promise; /** * Modifies an existing Amazon Redshift event notification subscription. */ modifyEventSubscription(input: AWS.Redshift.ModifyEventSubscriptionMessage, options: SdkCallOptions): Promise; /** * Modifies a scheduled action. */ modifyScheduledAction(input: AWS.Redshift.ModifyScheduledActionMessage, options: SdkCallOptions): Promise; /** * Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period. */ modifySnapshotCopyRetentionPeriod(input: AWS.Redshift.ModifySnapshotCopyRetentionPeriodMessage, options: SdkCallOptions): Promise; /** * Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously. */ modifySnapshotSchedule(input: AWS.Redshift.ModifySnapshotScheduleMessage, options: SdkCallOptions): Promise; /** * Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit. */ modifyUsageLimit(input: AWS.Redshift.ModifyUsageLimitMessage, options: SdkCallOptions): Promise; /** * Pauses a cluster. */ pauseCluster(input: AWS.Redshift.PauseClusterMessage, options: SdkCallOptions): Promise; /** * Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. */ purchaseReservedNodeOffering(input: AWS.Redshift.PurchaseReservedNodeOfferingMessage, options: SdkCallOptions): Promise; /** * Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. */ rebootCluster(input: AWS.Redshift.RebootClusterMessage, options: SdkCallOptions): Promise; /** * From a datashare consumer account, rejects the specified datashare. */ rejectDataShare(input: AWS.Redshift.RejectDataShareMessage, options: SdkCallOptions): Promise; /** * Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters. */ resetClusterParameterGroup(input: AWS.Redshift.ResetClusterParameterGroupMessage, options: SdkCallOptions): Promise; /** * Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc1.large (if your cluster is in a VPC) dc1.8xlarge (if your cluster is in a VPC) dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge ra3.xlplus ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster. */ resizeCluster(input: AWS.Redshift.ResizeClusterMessage, options: SdkCallOptions): Promise; /** * Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. */ restoreFromClusterSnapshot(input: AWS.Redshift.RestoreFromClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot. */ restoreTableFromClusterSnapshot(input: AWS.Redshift.RestoreTableFromClusterSnapshotMessage, options: SdkCallOptions): Promise; /** * Resumes a paused cluster. */ resumeCluster(input: AWS.Redshift.ResumeClusterMessage, options: SdkCallOptions): Promise; /** * Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. */ revokeClusterSecurityGroupIngress(input: AWS.Redshift.RevokeClusterSecurityGroupIngressMessage, options: SdkCallOptions): Promise; /** * Revokes access to a cluster. */ revokeEndpointAccess(input: AWS.Redshift.RevokeEndpointAccessMessage, options: SdkCallOptions): Promise; /** * Removes the ability of the specified Amazon Web Services account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide. */ revokeSnapshotAccess(input: AWS.Redshift.RevokeSnapshotAccessMessage, options: SdkCallOptions): Promise; /** * Rotates the encryption keys for a cluster. */ rotateEncryptionKey(input: AWS.Redshift.RotateEncryptionKeyMessage, options: SdkCallOptions): Promise; /** * Updates the status of a partner integration. */ updatePartnerStatus(input: AWS.Redshift.UpdatePartnerStatusInputMessage, options: SdkCallOptions): Promise; } export interface RedshiftData { /** * Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters: Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required. */ batchExecuteStatement(input: AWS.RedshiftData.BatchExecuteStatementInput, options: SdkCallOptions): Promise; /** * Cancels a running query. To be canceled, a query must be running. */ cancelStatement(input: AWS.RedshiftData.CancelStatementRequest, options: SdkCallOptions): Promise; /** * Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement. */ describeStatement(input: AWS.RedshiftData.DescribeStatementRequest, options: SdkCallOptions): Promise; /** * Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters: Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required. */ describeTable(input: AWS.RedshiftData.DescribeTableRequest, options: SdkCallOptions): Promise; /** * Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters: Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required. */ executeStatement(input: AWS.RedshiftData.ExecuteStatementInput, options: SdkCallOptions): Promise; /** * Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results. */ getStatementResult(input: AWS.RedshiftData.GetStatementResultRequest, options: SdkCallOptions): Promise; /** * List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters: Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required. */ listDatabases(input: AWS.RedshiftData.ListDatabasesRequest, options: SdkCallOptions): Promise; /** * Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters: Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required. */ listSchemas(input: AWS.RedshiftData.ListSchemasRequest, options: SdkCallOptions): Promise; /** * List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list. */ listStatements(input: AWS.RedshiftData.ListStatementsRequest, options: SdkCallOptions): Promise; /** * List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters: Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required. */ listTables(input: AWS.RedshiftData.ListTablesRequest, options: SdkCallOptions): Promise; } export interface RedshiftServerless { /** * Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points. */ convertRecoveryPointToSnapshot(input: AWS.RedshiftServerless.ConvertRecoveryPointToSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Redshift Serverless managed VPC endpoint. */ createEndpointAccess(input: AWS.RedshiftServerless.CreateEndpointAccessRequest, options: SdkCallOptions): Promise; /** * Creates a namespace in Amazon Redshift Serverless. */ createNamespace(input: AWS.RedshiftServerless.CreateNamespaceRequest, options: SdkCallOptions): Promise; /** * Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points. */ createSnapshot(input: AWS.RedshiftServerless.CreateSnapshotRequest, options: SdkCallOptions): Promise; /** * Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier. */ createUsageLimit(input: AWS.RedshiftServerless.CreateUsageLimitRequest, options: SdkCallOptions): Promise; /** * Creates an workgroup in Amazon Redshift Serverless. */ createWorkgroup(input: AWS.RedshiftServerless.CreateWorkgroupRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Redshift Serverless managed VPC endpoint. */ deleteEndpointAccess(input: AWS.RedshiftServerless.DeleteEndpointAccessRequest, options: SdkCallOptions): Promise; /** * Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace. */ deleteNamespace(input: AWS.RedshiftServerless.DeleteNamespaceRequest, options: SdkCallOptions): Promise; /** * Deletes the specified resource policy. */ deleteResourcePolicy(input: AWS.RedshiftServerless.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a snapshot from Amazon Redshift Serverless. */ deleteSnapshot(input: AWS.RedshiftServerless.DeleteSnapshotRequest, options: SdkCallOptions): Promise; /** * Deletes a usage limit from Amazon Redshift Serverless. */ deleteUsageLimit(input: AWS.RedshiftServerless.DeleteUsageLimitRequest, options: SdkCallOptions): Promise; /** * Deletes a workgroup. */ deleteWorkgroup(input: AWS.RedshiftServerless.DeleteWorkgroupRequest, options: SdkCallOptions): Promise; /** * Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). <p> The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources. </p> <p> If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p> */ getCredentials(input: AWS.RedshiftServerless.GetCredentialsRequest, options: SdkCallOptions): Promise; /** * Returns information, such as the name, about a VPC endpoint. */ getEndpointAccess(input: AWS.RedshiftServerless.GetEndpointAccessRequest, options: SdkCallOptions): Promise; /** * Returns information about a namespace in Amazon Redshift Serverless. */ getNamespace(input: AWS.RedshiftServerless.GetNamespaceRequest, options: SdkCallOptions): Promise; /** * Returns information about a recovery point. */ getRecoveryPoint(input: AWS.RedshiftServerless.GetRecoveryPointRequest, options: SdkCallOptions): Promise; /** * Returns a resource policy. */ getResourcePolicy(input: AWS.RedshiftServerless.GetResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific snapshot. */ getSnapshot(input: AWS.RedshiftServerless.GetSnapshotRequest, options: SdkCallOptions): Promise; /** * Returns information about a usage limit. */ getUsageLimit(input: AWS.RedshiftServerless.GetUsageLimitRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific workgroup. */ getWorkgroup(input: AWS.RedshiftServerless.GetWorkgroupRequest, options: SdkCallOptions): Promise; /** * Returns an array of EndpointAccess objects and relevant information. */ listEndpointAccess(input: AWS.RedshiftServerless.ListEndpointAccessRequest, options: SdkCallOptions): Promise; /** * Returns information about a list of specified namespaces. */ listNamespaces(input: AWS.RedshiftServerless.ListNamespacesRequest, options: SdkCallOptions): Promise; /** * Returns an array of recovery points. */ listRecoveryPoints(input: AWS.RedshiftServerless.ListRecoveryPointsRequest, options: SdkCallOptions): Promise; /** * Returns a list of snapshots. */ listSnapshots(input: AWS.RedshiftServerless.ListSnapshotsRequest, options: SdkCallOptions): Promise; /** * Lists the tags assigned to a resource. */ listTagsForResource(input: AWS.RedshiftServerless.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists all usage limits within Amazon Redshift Serverless. */ listUsageLimits(input: AWS.RedshiftServerless.ListUsageLimitsRequest, options: SdkCallOptions): Promise; /** * Returns information about a list of specified workgroups. */ listWorkgroups(input: AWS.RedshiftServerless.ListWorkgroupsRequest, options: SdkCallOptions): Promise; /** * Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts. */ putResourcePolicy(input: AWS.RedshiftServerless.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Restore the data from a recovery point. */ restoreFromRecoveryPoint(input: AWS.RedshiftServerless.RestoreFromRecoveryPointRequest, options: SdkCallOptions): Promise; /** * Restores a namespace from a snapshot. */ restoreFromSnapshot(input: AWS.RedshiftServerless.RestoreFromSnapshotRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags to a resource. */ tagResource(input: AWS.RedshiftServerless.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag or set of tags from a resource. */ untagResource(input: AWS.RedshiftServerless.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an Amazon Redshift Serverless managed endpoint. */ updateEndpointAccess(input: AWS.RedshiftServerless.UpdateEndpointAccessRequest, options: SdkCallOptions): Promise; /** * Updates a namespace with the specified settings. */ updateNamespace(input: AWS.RedshiftServerless.UpdateNamespaceRequest, options: SdkCallOptions): Promise; /** * Updates a snapshot. */ updateSnapshot(input: AWS.RedshiftServerless.UpdateSnapshotRequest, options: SdkCallOptions): Promise; /** * Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit. */ updateUsageLimit(input: AWS.RedshiftServerless.UpdateUsageLimitRequest, options: SdkCallOptions): Promise; /** * Updates a workgroup with the specified configuration settings. */ updateWorkgroup(input: AWS.RedshiftServerless.UpdateWorkgroupRequest, options: SdkCallOptions): Promise; } export interface Rekognition { /** * Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action. */ compareFaces(input: AWS.Rekognition.CompareFacesRequest, options: SdkCallOptions): Promise; /** * Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and destination projects can be in different AWS accounts but must be in the same AWS Region. You can't copy a model to another AWS service. To copy a model version to a different AWS account, you need to create a resource-based policy known as a project policy. You attach the project policy to the source project by calling PutProjectPolicy. The project policy gives permission to copy the model version from a trusting AWS account to a trusted account. For more information creating and attaching a project policy, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide. If you are copying a model version to a project in the same AWS account, you don't need to create a project policy. To copy a model, the destination project, source project, and source model version must already exist. Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the ProjectVersionDescription object. The copy operation has finished when the value of Status is COPYING_COMPLETED. */ copyProjectVersion(input: AWS.Rekognition.CopyProjectVersionRequest, options: SdkCallOptions): Promise; /** * Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation. For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. When you create a collection, it is associated with the latest version of the face model version. Collection names are case-sensitive. This operation requires permissions to perform the rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation. */ createCollection(input: AWS.Rekognition.CreateCollectionRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset. To create a training dataset for a project, specify train for the value of DatasetType. To create the test dataset for a project, specify test for the value of DatasetType. The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE. To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines. Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). Currently, you can't access the terminal error information. For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide. This operation requires permissions to perform the rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action. */ createDataset(input: AWS.Rekognition.CreateDatasetRequest, options: SdkCallOptions): Promise; /** * Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) that you use to create and manage Amazon Rekognition Custom Labels models. This operation requires permissions to perform the rekognition:CreateProject action. */ createProject(input: AWS.Rekognition.CreateProjectRequest, options: SdkCallOptions): Promise; /** * Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model. Training uses the training and test datasets associated with the project. For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide. You can train a model in a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields. If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files. Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project. Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED. If training fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels developers guide. After evaluating the model, you start the model by calling StartProjectVersion. This operation requires permissions to perform the rekognition:CreateProjectVersion action. */ createProjectVersion(input: AWS.Rekognition.CreateProjectVersionRequest, options: SdkCallOptions): Promise; /** * Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video. Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels. If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect in ConnectedHomeSettings, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field. This operation requires permissions to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation. */ createStreamProcessor(input: AWS.Rekognition.CreateStreamProcessorRequest, options: SdkCallOptions): Promise; /** * Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see Deleting a collection. This operation requires permissions to perform the rekognition:DeleteCollection action. */ deleteCollection(input: AWS.Rekognition.DeleteCollectionRequest, options: SdkCallOptions): Promise; /** * Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception. You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS). This operation requires permissions to perform the rekognition:DeleteDataset action. */ deleteDataset(input: AWS.Rekognition.DeleteDatasetRequest, options: SdkCallOptions): Promise; /** * Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. This operation requires permissions to perform the rekognition:DeleteFaces action. */ deleteFaces(input: AWS.Rekognition.DeleteFacesRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion. DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response. Be aware that deleting a given project will also delete any ProjectPolicies associated with that project. This operation requires permissions to perform the rekognition:DeleteProject action. */ deleteProject(input: AWS.Rekognition.DeleteProjectRequest, options: SdkCallOptions): Promise; /** * Deletes an existing project policy. To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy. */ deleteProjectPolicy(input: AWS.Rekognition.DeleteProjectPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes an Amazon Rekognition Custom Labels model. You can't delete a model if it is running or if it is training. To check the status of a model, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion. If the model is training, wait until it finishes. This operation requires permissions to perform the rekognition:DeleteProjectVersion action. */ deleteProjectVersion(input: AWS.Rekognition.DeleteProjectVersionRequest, options: SdkCallOptions): Promise; /** * Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor. */ deleteStreamProcessor(input: AWS.Rekognition.DeleteStreamProcessorRequest, options: SdkCallOptions): Promise; /** * Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection. For more information, see Describing a Collection in the Amazon Rekognition Developer Guide. */ describeCollection(input: AWS.Rekognition.DescribeCollectionRequest, options: SdkCallOptions): Promise; /** * Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset. This operation requires permissions to perform the rekognition:DescribeDataset action. */ describeDataset(input: AWS.Rekognition.DescribeDatasetRequest, options: SdkCallOptions): Promise; /** * Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all model versions in the project are returned. This operation requires permissions to perform the rekognition:DescribeProjectVersions action. */ describeProjectVersions(input: AWS.Rekognition.DescribeProjectVersionsRequest, options: SdkCallOptions): Promise; /** * Gets information about your Amazon Rekognition Custom Labels projects. This operation requires permissions to perform the rekognition:DescribeProjects action. */ describeProjects(input: AWS.Rekognition.DescribeProjectsRequest, options: SdkCallOptions): Promise; /** * Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor. */ describeStreamProcessor(input: AWS.Rekognition.DescribeStreamProcessorRequest, options: SdkCallOptions): Promise; /** * Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. You specify which version of a model version to use by using the ProjectVersionArn input parameter. You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry). To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide. If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectCustomLabels action. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide. */ detectCustomLabels(input: AWS.Rekognition.DetectCustomLabelsRequest, options: SdkCallOptions): Promise; /** * Detects faces within an image that is provided as input. DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of beard, sunglasses, and so on. The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectFaces action. */ detectFaces(input: AWS.Rekognition.DetectFacesRequest, options: SdkCallOptions): Promise; /** * Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide. DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide. You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object. {Name: lighthouse, Confidence: 98.4629} {Name: rock,Confidence: 79.2097} {Name: sea,Confidence: 75.061} In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. {Name: flower,Confidence: 99.0562} {Name: plant,Confidence: 99.0562} {Name: tulip,Confidence: 99.0562} In this example, the detection algorithm more precisely identifies the flower as a tulip. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned. If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides. DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected. DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectLabels action. */ detectLabels(input: AWS.Rekognition.DetectLabelsRequest, options: SdkCallOptions): Promise; /** * Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content. To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate. For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. */ detectModerationLabels(input: AWS.Rekognition.DetectModerationLabelsRequest, options: SdkCallOptions): Promise; /** * Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE. Face cover Hand cover Head cover You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file. DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image. For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE. You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information. The persons detected as wearing all of the types of PPE that you specify. The persons detected as not wearing all of the types PPE that you specify. The persons detected where PPE adornment could not be determined. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action. */ detectProtectiveEquipment(input: AWS.Rekognition.DetectProtectiveEquipmentRequest, options: SdkCallOptions): Promise; /** * Detects text in the input image and converts it into machine-readable text. Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file. The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image. A word is one or more script characters that are not separated by spaces. DetectText can detect up to 100 words in an image. A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines. To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field. To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. For more information, see Detecting text in the Amazon Rekognition Developer Guide. */ detectText(input: AWS.Rekognition.DetectTextRequest, options: SdkCallOptions): Promise; /** * Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image. You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset. Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is UPDATE_FAILED. This operation requires permissions to perform the rekognition:DistributeDatasetEntries action. */ distributeDatasetEntries(input: AWS.Rekognition.DistributeDatasetEntriesRequest, options: SdkCallOptions): Promise; /** * Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see Getting information about a celebrity in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:GetCelebrityInfo action. */ getCelebrityInfo(input: AWS.Rekognition.GetCelebrityInfoRequest, options: SdkCallOptions): Promise; /** * Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition. Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection. For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide. GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate. GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The BoundingBox field only applies to the detected face instance. The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter. The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer. No information is returned for faces not recognized as celebrities. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition. */ getCelebrityRecognition(input: AWS.Rekognition.GetCelebrityRecognitionRequest, options: SdkCallOptions): Promise; /** * Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs. Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide. GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects. By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter. Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration. For more information, see moderating content in the Amazon Rekognition Developer Guide. */ getContentModeration(input: AWS.Rekognition.GetContentModerationRequest, options: SdkCallOptions): Promise; /** * Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection. Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection. */ getFaceDetection(input: AWS.Rekognition.GetFaceDetectionRequest, options: SdkCallOptions): Promise; /** * Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video. Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video. GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter. */ getFaceSearch(input: AWS.Rekognition.GetFaceSearchRequest, options: SdkCallOptions): Promise; /** * Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection. The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video. The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection. */ getLabelDetection(input: AWS.Rekognition.GetLabelDetectionRequest, options: SdkCallOptions): Promise; /** * Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking. The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking. To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking. GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video. GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter. Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking. */ getPersonTracking(input: AWS.Rekognition.GetPersonTrackingRequest, options: SdkCallOptions): Promise; /** * Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection. Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection. GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected. Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection. Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection. For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide. */ getSegmentDetection(input: AWS.Rekognition.GetSegmentDetectionRequest, options: SdkCallOptions): Promise; /** * Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection. Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection. GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video. Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines. Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection. */ getTextDetection(input: AWS.Rekognition.GetTextDetectionRequest, options: SdkCallOptions): Promise; /** * Detects faces in the input image and adds them to the specified collection. Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations. For more information, see Adding faces to a collection in the Amazon Rekognition Developer Guide. To get the number of faces in a collection, call DescribeCollection. If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field. To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces For more information, see Model Versioning in the Amazon Rekognition Developer Guide. If you provide the optional ExternalImageId for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection. Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as: The number of faces detected exceeds the value of the MaxFaces request parameter. The face is too small compared to the image dimensions. The face is too blurry. The image is too dark. The face has an extreme pose. The face doesn’t have enough detail to be suitable for face search. In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes: The bounding box, BoundingBox, of the detected face. A confidence value, Confidence, which indicates the confidence that the bounding box contains a face. A face ID, FaceId, assigned by the service for each face that's detected and stored. An image ID, ImageId, assigned by the service for the input image. If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata. The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. This operation requires permissions to perform the rekognition:IndexFaces action. */ indexFaces(input: AWS.Rekognition.IndexFacesRequest, options: SdkCallOptions): Promise; /** * Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs. For an example, see Listing collections in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListCollections action. */ listCollections(input: AWS.Rekognition.ListCollectionsRequest, options: SdkCallOptions): Promise; /** * Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file. JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training. You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date. This operation requires permissions to perform the rekognition:ListDatasetEntries action. */ listDatasetEntries(input: AWS.Rekognition.ListDatasetEntriesRequest, options: SdkCallOptions): Promise; /** * Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images. Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide. */ listDatasetLabels(input: AWS.Rekognition.ListDatasetLabelsRequest, options: SdkCallOptions): Promise; /** * Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListFaces action. */ listFaces(input: AWS.Rekognition.ListFacesRequest, options: SdkCallOptions): Promise; /** * Gets a list of the project policies attached to a project. To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy. */ listProjectPolicies(input: AWS.Rekognition.ListProjectPoliciesRequest, options: SdkCallOptions): Promise; /** * Gets a list of stream processors that you have created with CreateStreamProcessor. */ listStreamProcessors(input: AWS.Rekognition.ListStreamProcessorsRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model. This operation requires permissions to perform the rekognition:ListTagsForResource action. */ listTagsForResource(input: AWS.Rekognition.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A project policy specifies that a trusted AWS account can copy a model version from a trusting AWS account to a project in the trusted AWS account. To copy a model version you use the CopyProjectVersion operation. For more information about the format of a project policy document, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide. The response from PutProjectPolicy is a revision ID for the project policy. You can attach multiple project policies to a project. You can also update an existing project policy by specifying the policy revision ID of the existing policy. To remove a project policy from a project, call DeleteProjectPolicy. To get a list of project policies attached to a project, call ListProjectPolicies. You copy a model version by calling CopyProjectVersion. */ putProjectPolicy(input: AWS.Rekognition.PutProjectPolicyRequest, options: SdkCallOptions): Promise; /** * Returns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the 64 largest faces in the image. It lists the recognized celebrities in the CelebrityFaces array and any unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image. Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities operation. */ recognizeCelebrities(input: AWS.Rekognition.RecognizeCelebritiesRequest, options: SdkCallOptions): Promise; /** * For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection. You can also search faces without indexing faces by using the SearchFacesByImage operation. The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face. For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFaces action. */ searchFaces(input: AWS.Rekognition.SearchFacesRequest, options: SdkCallOptions): Promise; /** * For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. If no faces are detected in the input image, SearchFacesByImage returns an InvalidParameterException error. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection. This operation requires permissions to perform the rekognition:SearchFacesByImage action. */ searchFacesByImage(input: AWS.Rekognition.SearchFacesByImageRequest, options: SdkCallOptions): Promise; /** * Starts asynchronous recognition of celebrities in a stored video. Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition. For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. */ startCelebrityRecognition(input: AWS.Rekognition.StartCelebrityRecognitionRequest, options: SdkCallOptions): Promise; /** * Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs. Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Moderating content in the Amazon Rekognition Developer Guide. */ startContentModeration(input: AWS.Rekognition.StartContentModerationRequest, options: SdkCallOptions): Promise; /** * Starts asynchronous detection of faces in a stored video. Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. For more information, see Detecting faces in a stored video in the Amazon Rekognition Developer Guide. */ startFaceDetection(input: AWS.Rekognition.StartFaceDetectionRequest, options: SdkCallOptions): Promise; /** * Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see Searching stored videos for faces. */ startFaceSearch(input: AWS.Rekognition.StartFaceSearchRequest, options: SdkCallOptions): Promise; /** * Starts asynchronous detection of labels in a stored video. Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. */ startLabelDetection(input: AWS.Rekognition.StartLabelDetectionRequest, options: SdkCallOptions): Promise; /** * Starts the asynchronous tracking of a person's path in a stored video. Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking. */ startPersonTracking(input: AWS.Rekognition.StartPersonTrackingRequest, options: SdkCallOptions): Promise; /** * Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions. Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels. You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion. For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide. This operation requires permissions to perform the rekognition:StartProjectVersion action. */ startProjectVersion(input: AWS.Rekognition.StartProjectVersionRequest, options: SdkCallOptions): Promise; /** * Starts asynchronous detection of segment detection in a stored video. Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection. For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide. */ startSegmentDetection(input: AWS.Rekognition.StartSegmentDetectionRequest, options: SdkCallOptions): Promise; /** * Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor. If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time. */ startStreamProcessor(input: AWS.Rekognition.StartStreamProcessorRequest, options: SdkCallOptions): Promise; /** * Starts asynchronous detection of text in a stored video. Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection. */ startTextDetection(input: AWS.Rekognition.StartTextDetectionRequest, options: SdkCallOptions): Promise; /** * Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions. */ stopProjectVersion(input: AWS.Rekognition.StopProjectVersionRequest, options: SdkCallOptions): Promise; /** * Stops a running stream processor that was created by CreateStreamProcessor. */ stopStreamProcessor(input: AWS.Rekognition.StopStreamProcessorRequest, options: SdkCallOptions): Promise; /** * Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources. This operation requires permissions to perform the rekognition:TagResource action. */ tagResource(input: AWS.Rekognition.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model. This operation requires permissions to perform the rekognition:UntagResource action. */ untagResource(input: AWS.Rekognition.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide. If the source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset. You specify the changes that you want to make in the Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB. UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE. To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines. Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK. This operation requires permissions to perform the rekognition:UpdateDatasetEntries action. */ updateDatasetEntries(input: AWS.Rekognition.UpdateDatasetEntriesRequest, options: SdkCallOptions): Promise; /** * Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters. */ updateStreamProcessor(input: AWS.Rekognition.UpdateStreamProcessorRequest, options: SdkCallOptions): Promise; } export interface Resiliencehub { /** * Adds the resource mapping for the draft application version. */ addDraftAppVersionResourceMappings(input: AWS.Resiliencehub.AddDraftAppVersionResourceMappingsRequest, options: SdkCallOptions): Promise; /** * Creates a Resilience Hub application. A Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more–up to five–CloudFormation stacks, and an appropriate resiliency policy. <p>After you create a Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).</p> */ createApp(input: AWS.Resiliencehub.CreateAppRequest, options: SdkCallOptions): Promise; /** * Creates a new recommendation template. */ createRecommendationTemplate(input: AWS.Resiliencehub.CreateRecommendationTemplateRequest, options: SdkCallOptions): Promise; /** * Creates a resiliency policy for an application. */ createResiliencyPolicy(input: AWS.Resiliencehub.CreateResiliencyPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes an AWS Resilience Hub application. This is a destructive action that can't be undone. */ deleteApp(input: AWS.Resiliencehub.DeleteAppRequest, options: SdkCallOptions): Promise; /** * Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't be undone. */ deleteAppAssessment(input: AWS.Resiliencehub.DeleteAppAssessmentRequest, options: SdkCallOptions): Promise; /** * Deletes a recommendation template. This is a destructive action that can't be undone. */ deleteRecommendationTemplate(input: AWS.Resiliencehub.DeleteRecommendationTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a resiliency policy. This is a destructive action that can't be undone. */ deleteResiliencyPolicy(input: AWS.Resiliencehub.DeleteResiliencyPolicyRequest, options: SdkCallOptions): Promise; /** * Describes an AWS Resilience Hub application. */ describeApp(input: AWS.Resiliencehub.DescribeAppRequest, options: SdkCallOptions): Promise; /** * Describes an assessment for an AWS Resilience Hub application. */ describeAppAssessment(input: AWS.Resiliencehub.DescribeAppAssessmentRequest, options: SdkCallOptions): Promise; /** * Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned. */ describeAppVersionResourcesResolutionStatus(input: AWS.Resiliencehub.DescribeAppVersionResourcesResolutionStatusRequest, options: SdkCallOptions): Promise; /** * Describes details about an AWS Resilience Hub */ describeAppVersionTemplate(input: AWS.Resiliencehub.DescribeAppVersionTemplateRequest, options: SdkCallOptions): Promise; /** * Describes the status of importing resources to an application version. */ describeDraftAppVersionResourcesImportStatus(input: AWS.Resiliencehub.DescribeDraftAppVersionResourcesImportStatusRequest, options: SdkCallOptions): Promise; /** * Describes a specified resiliency policy for an AWS Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more. */ describeResiliencyPolicy(input: AWS.Resiliencehub.DescribeResiliencyPolicyRequest, options: SdkCallOptions): Promise; /** * Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version. */ importResourcesToDraftAppVersion(input: AWS.Resiliencehub.ImportResourcesToDraftAppVersionRequest, options: SdkCallOptions): Promise; /** * Lists the alarm recommendations for a AWS Resilience Hub application. */ listAlarmRecommendations(input: AWS.Resiliencehub.ListAlarmRecommendationsRequest, options: SdkCallOptions): Promise; /** * Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object. */ listAppAssessments(input: AWS.Resiliencehub.ListAppAssessmentsRequest, options: SdkCallOptions): Promise; /** * Lists the compliances for an AWS Resilience Hub component. */ listAppComponentCompliances(input: AWS.Resiliencehub.ListAppComponentCompliancesRequest, options: SdkCallOptions): Promise; /** * Lists the recommendations for an AWS Resilience Hub component. */ listAppComponentRecommendations(input: AWS.Resiliencehub.ListAppComponentRecommendationsRequest, options: SdkCallOptions): Promise; /** * Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app. */ listAppVersionResourceMappings(input: AWS.Resiliencehub.ListAppVersionResourceMappingsRequest, options: SdkCallOptions): Promise; /** * Lists all the resources in an application version. */ listAppVersionResources(input: AWS.Resiliencehub.ListAppVersionResourcesRequest, options: SdkCallOptions): Promise; /** * Lists the different versions for the Resilience Hub applications. */ listAppVersions(input: AWS.Resiliencehub.ListAppVersionsRequest, options: SdkCallOptions): Promise; /** * Lists your Resilience Hub applications. */ listApps(input: AWS.Resiliencehub.ListAppsRequest, options: SdkCallOptions): Promise; /** * Lists the recommendation templates for the Resilience Hub applications. */ listRecommendationTemplates(input: AWS.Resiliencehub.ListRecommendationTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists the resiliency policies for the Resilience Hub applications. */ listResiliencyPolicies(input: AWS.Resiliencehub.ListResiliencyPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications. */ listSopRecommendations(input: AWS.Resiliencehub.ListSopRecommendationsRequest, options: SdkCallOptions): Promise; /** * Lists the suggested resiliency policies for the Resilience Hub applications. */ listSuggestedResiliencyPolicies(input: AWS.Resiliencehub.ListSuggestedResiliencyPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the tags for your resources in your Resilience Hub applications. */ listTagsForResource(input: AWS.Resiliencehub.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the test recommendations for the Resilience Hub application. */ listTestRecommendations(input: AWS.Resiliencehub.ListTestRecommendationsRequest, options: SdkCallOptions): Promise; /** * Lists the resources that are not currently supported in AWS Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub. */ listUnsupportedAppVersionResources(input: AWS.Resiliencehub.ListUnsupportedAppVersionResourcesRequest, options: SdkCallOptions): Promise; /** * Publishes a new version of a specific Resilience Hub application. */ publishAppVersion(input: AWS.Resiliencehub.PublishAppVersionRequest, options: SdkCallOptions): Promise; /** * Adds or updates the app template for a draft version of a Resilience Hub app. */ putDraftAppVersionTemplate(input: AWS.Resiliencehub.PutDraftAppVersionTemplateRequest, options: SdkCallOptions): Promise; /** * Removes resource mappings from a draft application version. */ removeDraftAppVersionResourceMappings(input: AWS.Resiliencehub.RemoveDraftAppVersionResourceMappingsRequest, options: SdkCallOptions): Promise; /** * Resolves the resources for an application version. */ resolveAppVersionResources(input: AWS.Resiliencehub.ResolveAppVersionResourcesRequest, options: SdkCallOptions): Promise; /** * Creates a new application assessment for an application. */ startAppAssessment(input: AWS.Resiliencehub.StartAppAssessmentRequest, options: SdkCallOptions): Promise; /** * Applies one or more tags to a resource. */ tagResource(input: AWS.Resiliencehub.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a resource. */ untagResource(input: AWS.Resiliencehub.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an application. */ updateApp(input: AWS.Resiliencehub.UpdateAppRequest, options: SdkCallOptions): Promise; /** * Updates a resiliency policy. */ updateResiliencyPolicy(input: AWS.Resiliencehub.UpdateResiliencyPolicyRequest, options: SdkCallOptions): Promise; } export interface ResourceGroups { /** * Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups. For more information about service configurations, see Service configurations for resource groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:CreateGroup */ createGroup(input: AWS.ResourceGroups.CreateGroupInput, options: SdkCallOptions): Promise; /** * Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure. Minimum permissions To run this command, you must have the following permissions: resource-groups:DeleteGroup */ deleteGroup(input: AWS.ResourceGroups.DeleteGroupInput, options: SdkCallOptions): Promise; /** * Returns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroup */ getGroup(input: AWS.ResourceGroups.GetGroupInput, options: SdkCallOptions): Promise; /** * Returns the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for resource groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupConfiguration */ getGroupConfiguration(input: AWS.ResourceGroups.GetGroupConfigurationInput, options: SdkCallOptions): Promise; /** * Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupQuery */ getGroupQuery(input: AWS.ResourceGroups.GetGroupQueryInput, options: SdkCallOptions): Promise; /** * Returns a list of tags that are associated with a resource group, specified by an ARN. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetTags */ getTags(input: AWS.ResourceGroups.GetTagsInput, options: SdkCallOptions): Promise; /** * Adds the specified resources to the specified group. Minimum permissions To run this command, you must have the following permissions: resource-groups:GroupResources */ groupResources(input: AWS.ResourceGroups.GroupResourcesInput, options: SdkCallOptions): Promise; /** * Returns a list of ARNs of the resources that are members of a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroupResources cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources */ listGroupResources(input: AWS.ResourceGroups.ListGroupResourcesInput, options: SdkCallOptions): Promise; /** * Returns a list of existing resource groups in your account. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroups */ listGroups(input: AWS.ResourceGroups.ListGroupsInput, options: SdkCallOptions): Promise; /** * Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions: resource-groups:PutGroupConfiguration */ putGroupConfiguration(input: AWS.ResourceGroups.PutGroupConfigurationInput, options: SdkCallOptions): Promise; /** * Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. Minimum permissions To run this command, you must have the following permissions: resource-groups:SearchResources cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources */ searchResources(input: AWS.ResourceGroups.SearchResourcesInput, options: SdkCallOptions): Promise; /** * Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions To run this command, you must have the following permissions: resource-groups:Tag */ tag(input: AWS.ResourceGroups.TagInput, options: SdkCallOptions): Promise; /** * Removes the specified resources from the specified group. Minimum permissions To run this command, you must have the following permissions: resource-groups:UngroupResources */ ungroupResources(input: AWS.ResourceGroups.UngroupResourcesInput, options: SdkCallOptions): Promise; /** * Deletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:Untag */ untag(input: AWS.ResourceGroups.UntagInput, options: SdkCallOptions): Promise; /** * Updates the description for an existing group. You cannot update the name of a resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroup */ updateGroup(input: AWS.ResourceGroups.UpdateGroupInput, options: SdkCallOptions): Promise; /** * Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroupQuery */ updateGroupQuery(input: AWS.ResourceGroups.UpdateGroupQueryInput, options: SdkCallOptions): Promise; } export interface ResourceGroupsTaggingAPI { /** * Describes the status of the StartReportCreation operation. You can call this operation only from the organization's management account and from the us-east-1 Region. */ describeReportCreation(input: AWS.ResourceGroupsTaggingAPI.DescribeReportCreationInput, options: SdkCallOptions): Promise; /** * Returns a table that shows counts of resources that are noncompliant with their tag policies. For more information on tag policies, see Tag Policies in the Organizations User Guide. You can call this operation only from the organization's management account and from the us-east-1 Region. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned. */ getComplianceSummary(input: AWS.ResourceGroupsTaggingAPI.GetComplianceSummaryInput, options: SdkCallOptions): Promise; /** * Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account. Depending on what information you want returned, you can also specify the following: Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources. Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the Organizations User Guide. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned. */ getResources(input: AWS.ResourceGroupsTaggingAPI.GetResourcesInput, options: SdkCallOptions): Promise; /** * Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned. */ getTagKeys(input: AWS.ResourceGroupsTaggingAPI.GetTagKeysInput, options: SdkCallOptions): Promise; /** * Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned. */ getTagValues(input: AWS.ResourceGroupsTaggingAPI.GetTagValuesInput, options: SdkCallOptions): Promise; /** * Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously. The generated report is saved to the following location: s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv You can call this operation only from the organization's management account and from the us-east-1 Region. */ startReportCreation(input: AWS.ResourceGroupsTaggingAPI.StartReportCreationInput, options: SdkCallOptions): Promise; /** * Applies one or more tags to the specified resources. Note the following: Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service. Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the Amazon Web Services General Reference. You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account. To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag an Amazon EC2 instance using the TagResources operation, you must have both of the following permissions: tag:TagResource ec2:CreateTags */ tagResources(input: AWS.ResourceGroupsTaggingAPI.TagResourcesInput, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag. You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account. Minimum permissions In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions: tag:UntagResource ec2:DeleteTags */ untagResources(input: AWS.ResourceGroupsTaggingAPI.UntagResourcesInput, options: SdkCallOptions): Promise; } export interface RoboMaker { /** * Deletes one or more worlds in a batch operation. */ batchDeleteWorlds(input: AWS.RoboMaker.BatchDeleteWorldsRequest, options: SdkCallOptions): Promise; /** * Describes one or more simulation jobs. */ batchDescribeSimulationJob(input: AWS.RoboMaker.BatchDescribeSimulationJobRequest, options: SdkCallOptions): Promise; /** * Cancels the specified deployment job. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ cancelDeploymentJob(input: AWS.RoboMaker.CancelDeploymentJobRequest, options: SdkCallOptions): Promise; /** * Cancels the specified simulation job. */ cancelSimulationJob(input: AWS.RoboMaker.CancelSimulationJobRequest, options: SdkCallOptions): Promise; /** * Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch. */ cancelSimulationJobBatch(input: AWS.RoboMaker.CancelSimulationJobBatchRequest, options: SdkCallOptions): Promise; /** * Cancels the specified export job. */ cancelWorldExportJob(input: AWS.RoboMaker.CancelWorldExportJobRequest, options: SdkCallOptions): Promise; /** * Cancels the specified world generator job. */ cancelWorldGenerationJob(input: AWS.RoboMaker.CancelWorldGenerationJobRequest, options: SdkCallOptions): Promise; /** * Deploys a specific version of a robot application to robots in a fleet. This API is no longer supported and will throw an error if used. The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible. */ createDeploymentJob(input: AWS.RoboMaker.CreateDeploymentJobRequest, options: SdkCallOptions): Promise; /** * Creates a fleet, a logical group of robots running the same robot application. This API is no longer supported and will throw an error if used. */ createFleet(input: AWS.RoboMaker.CreateFleetRequest, options: SdkCallOptions): Promise; /** * Creates a robot. This API is no longer supported and will throw an error if used. */ createRobot(input: AWS.RoboMaker.CreateRobotRequest, options: SdkCallOptions): Promise; /** * Creates a robot application. */ createRobotApplication(input: AWS.RoboMaker.CreateRobotApplicationRequest, options: SdkCallOptions): Promise; /** * Creates a version of a robot application. */ createRobotApplicationVersion(input: AWS.RoboMaker.CreateRobotApplicationVersionRequest, options: SdkCallOptions): Promise; /** * Creates a simulation application. */ createSimulationApplication(input: AWS.RoboMaker.CreateSimulationApplicationRequest, options: SdkCallOptions): Promise; /** * Creates a simulation application with a specific revision id. */ createSimulationApplicationVersion(input: AWS.RoboMaker.CreateSimulationApplicationVersionRequest, options: SdkCallOptions): Promise; /** * Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible. */ createSimulationJob(input: AWS.RoboMaker.CreateSimulationJobRequest, options: SdkCallOptions): Promise; /** * Creates a world export job. */ createWorldExportJob(input: AWS.RoboMaker.CreateWorldExportJobRequest, options: SdkCallOptions): Promise; /** * Creates worlds using the specified template. */ createWorldGenerationJob(input: AWS.RoboMaker.CreateWorldGenerationJobRequest, options: SdkCallOptions): Promise; /** * Creates a world template. */ createWorldTemplate(input: AWS.RoboMaker.CreateWorldTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a fleet. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ deleteFleet(input: AWS.RoboMaker.DeleteFleetRequest, options: SdkCallOptions): Promise; /** * Deletes a robot. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ deleteRobot(input: AWS.RoboMaker.DeleteRobotRequest, options: SdkCallOptions): Promise; /** * Deletes a robot application. */ deleteRobotApplication(input: AWS.RoboMaker.DeleteRobotApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes a simulation application. */ deleteSimulationApplication(input: AWS.RoboMaker.DeleteSimulationApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes a world template. */ deleteWorldTemplate(input: AWS.RoboMaker.DeleteWorldTemplateRequest, options: SdkCallOptions): Promise; /** * Deregisters a robot. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ deregisterRobot(input: AWS.RoboMaker.DeregisterRobotRequest, options: SdkCallOptions): Promise; /** * Describes a deployment job. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ describeDeploymentJob(input: AWS.RoboMaker.DescribeDeploymentJobRequest, options: SdkCallOptions): Promise; /** * Describes a fleet. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ describeFleet(input: AWS.RoboMaker.DescribeFleetRequest, options: SdkCallOptions): Promise; /** * Describes a robot. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ describeRobot(input: AWS.RoboMaker.DescribeRobotRequest, options: SdkCallOptions): Promise; /** * Describes a robot application. */ describeRobotApplication(input: AWS.RoboMaker.DescribeRobotApplicationRequest, options: SdkCallOptions): Promise; /** * Describes a simulation application. */ describeSimulationApplication(input: AWS.RoboMaker.DescribeSimulationApplicationRequest, options: SdkCallOptions): Promise; /** * Describes a simulation job. */ describeSimulationJob(input: AWS.RoboMaker.DescribeSimulationJobRequest, options: SdkCallOptions): Promise; /** * Describes a simulation job batch. */ describeSimulationJobBatch(input: AWS.RoboMaker.DescribeSimulationJobBatchRequest, options: SdkCallOptions): Promise; /** * Describes a world. */ describeWorld(input: AWS.RoboMaker.DescribeWorldRequest, options: SdkCallOptions): Promise; /** * Describes a world export job. */ describeWorldExportJob(input: AWS.RoboMaker.DescribeWorldExportJobRequest, options: SdkCallOptions): Promise; /** * Describes a world generation job. */ describeWorldGenerationJob(input: AWS.RoboMaker.DescribeWorldGenerationJobRequest, options: SdkCallOptions): Promise; /** * Describes a world template. */ describeWorldTemplate(input: AWS.RoboMaker.DescribeWorldTemplateRequest, options: SdkCallOptions): Promise; /** * Gets the world template body. */ getWorldTemplateBody(input: AWS.RoboMaker.GetWorldTemplateBodyRequest, options: SdkCallOptions): Promise; /** * Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ listDeploymentJobs(input: AWS.RoboMaker.ListDeploymentJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of fleets. You can optionally provide filters to retrieve specific fleets. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ listFleets(input: AWS.RoboMaker.ListFleetsRequest, options: SdkCallOptions): Promise; /** * Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications. */ listRobotApplications(input: AWS.RoboMaker.ListRobotApplicationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of robots. You can optionally provide filters to retrieve specific robots. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ listRobots(input: AWS.RoboMaker.ListRobotsRequest, options: SdkCallOptions): Promise; /** * Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications. */ listSimulationApplications(input: AWS.RoboMaker.ListSimulationApplicationsRequest, options: SdkCallOptions): Promise; /** * Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs. */ listSimulationJobBatches(input: AWS.RoboMaker.ListSimulationJobBatchesRequest, options: SdkCallOptions): Promise; /** * Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs. */ listSimulationJobs(input: AWS.RoboMaker.ListSimulationJobsRequest, options: SdkCallOptions): Promise; /** * Lists all tags on a AWS RoboMaker resource. */ listTagsForResource(input: AWS.RoboMaker.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists world export jobs. */ listWorldExportJobs(input: AWS.RoboMaker.ListWorldExportJobsRequest, options: SdkCallOptions): Promise; /** * Lists world generator jobs. */ listWorldGenerationJobs(input: AWS.RoboMaker.ListWorldGenerationJobsRequest, options: SdkCallOptions): Promise; /** * Lists world templates. */ listWorldTemplates(input: AWS.RoboMaker.ListWorldTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists worlds. */ listWorlds(input: AWS.RoboMaker.ListWorldsRequest, options: SdkCallOptions): Promise; /** * Registers a robot with a fleet. This API is no longer supported and will throw an error if used. */ registerRobot(input: AWS.RoboMaker.RegisterRobotRequest, options: SdkCallOptions): Promise; /** * Restarts a running simulation job. */ restartSimulationJob(input: AWS.RoboMaker.RestartSimulationJobRequest, options: SdkCallOptions): Promise; /** * Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects. */ startSimulationJobBatch(input: AWS.RoboMaker.StartSimulationJobBatchRequest, options: SdkCallOptions): Promise; /** * Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. */ syncDeploymentJob(input: AWS.RoboMaker.SyncDeploymentJobRequest, options: SdkCallOptions): Promise; /** * Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide. */ tagResource(input: AWS.RoboMaker.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified AWS RoboMaker resource. To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource . */ untagResource(input: AWS.RoboMaker.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a robot application. */ updateRobotApplication(input: AWS.RoboMaker.UpdateRobotApplicationRequest, options: SdkCallOptions): Promise; /** * Updates a simulation application. */ updateSimulationApplication(input: AWS.RoboMaker.UpdateSimulationApplicationRequest, options: SdkCallOptions): Promise; /** * Updates a world template. */ updateWorldTemplate(input: AWS.RoboMaker.UpdateWorldTemplateRequest, options: SdkCallOptions): Promise; } export interface RolesAnywhere { /** * Creates a profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies. Required permissions: rolesanywhere:CreateProfile. */ createProfile(input: AWS.RolesAnywhere.CreateProfileRequest, options: SdkCallOptions): Promise; /** * Creates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials. Required permissions: rolesanywhere:CreateTrustAnchor. */ createTrustAnchor(input: AWS.RolesAnywhere.CreateTrustAnchorRequest, options: SdkCallOptions): Promise; /** * Deletes a certificate revocation list (CRL). Required permissions: rolesanywhere:DeleteCrl. */ deleteCrl(input: AWS.RolesAnywhere.ScalarCrlRequest, options: SdkCallOptions): Promise; /** * Deletes a profile. Required permissions: rolesanywhere:DeleteProfile. */ deleteProfile(input: AWS.RolesAnywhere.ScalarProfileRequest, options: SdkCallOptions): Promise; /** * Deletes a trust anchor. Required permissions: rolesanywhere:DeleteTrustAnchor. */ deleteTrustAnchor(input: AWS.RolesAnywhere.ScalarTrustAnchorRequest, options: SdkCallOptions): Promise; /** * Disables a certificate revocation list (CRL). Required permissions: rolesanywhere:DisableCrl. */ disableCrl(input: AWS.RolesAnywhere.ScalarCrlRequest, options: SdkCallOptions): Promise; /** * Disables a profile. When disabled, CreateSession requests with this profile fail. Required permissions: rolesanywhere:DisableProfile. */ disableProfile(input: AWS.RolesAnywhere.ScalarProfileRequest, options: SdkCallOptions): Promise; /** * Disables a trust anchor. When disabled, CreateSession requests specifying this trust anchor are unauthorized. Required permissions: rolesanywhere:DisableTrustAnchor. */ disableTrustAnchor(input: AWS.RolesAnywhere.ScalarTrustAnchorRequest, options: SdkCallOptions): Promise; /** * Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials. Required permissions: rolesanywhere:EnableCrl. */ enableCrl(input: AWS.RolesAnywhere.ScalarCrlRequest, options: SdkCallOptions): Promise; /** * Enables the roles in a profile to receive session credentials in CreateSession. Required permissions: rolesanywhere:EnableProfile. */ enableProfile(input: AWS.RolesAnywhere.ScalarProfileRequest, options: SdkCallOptions): Promise; /** * Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation. Required permissions: rolesanywhere:EnableTrustAnchor. */ enableTrustAnchor(input: AWS.RolesAnywhere.ScalarTrustAnchorRequest, options: SdkCallOptions): Promise; /** * Gets a certificate revocation list (CRL). Required permissions: rolesanywhere:GetCrl. */ getCrl(input: AWS.RolesAnywhere.ScalarCrlRequest, options: SdkCallOptions): Promise; /** * Gets a profile. Required permissions: rolesanywhere:GetProfile. */ getProfile(input: AWS.RolesAnywhere.ScalarProfileRequest, options: SdkCallOptions): Promise; /** * Gets a Subject. A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication. Required permissions: rolesanywhere:GetSubject. */ getSubject(input: AWS.RolesAnywhere.ScalarSubjectRequest, options: SdkCallOptions): Promise; /** * Gets a trust anchor. Required permissions: rolesanywhere:GetTrustAnchor. */ getTrustAnchor(input: AWS.RolesAnywhere.ScalarTrustAnchorRequest, options: SdkCallOptions): Promise; /** * Imports the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials. Required permissions: rolesanywhere:ImportCrl. */ importCrl(input: AWS.RolesAnywhere.ImportCrlRequest, options: SdkCallOptions): Promise; /** * Lists all Crls in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListCrls. */ listCrls(input: AWS.RolesAnywhere.ListRequest, options: SdkCallOptions): Promise; /** * Lists all profiles in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListProfiles. */ listProfiles(input: AWS.RolesAnywhere.ListRequest, options: SdkCallOptions): Promise; /** * Lists the subjects in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListSubjects. */ listSubjects(input: AWS.RolesAnywhere.ListRequest, options: SdkCallOptions): Promise; /** * Lists the tags attached to the resource. Required permissions: rolesanywhere:ListTagsForResource. */ listTagsForResource(input: AWS.RolesAnywhere.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the trust anchors in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListTrustAnchors. */ listTrustAnchors(input: AWS.RolesAnywhere.ListRequest, options: SdkCallOptions): Promise; /** * Attaches tags to a resource. Required permissions: rolesanywhere:TagResource. */ tagResource(input: AWS.RolesAnywhere.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from the resource. Required permissions: rolesanywhere:UntagResource. */ untagResource(input: AWS.RolesAnywhere.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials. Required permissions: rolesanywhere:UpdateCrl. */ updateCrl(input: AWS.RolesAnywhere.UpdateCrlRequest, options: SdkCallOptions): Promise; /** * Updates the profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can scope-down permissions with IAM managed policies. Required permissions: rolesanywhere:UpdateProfile. */ updateProfile(input: AWS.RolesAnywhere.UpdateProfileRequest, options: SdkCallOptions): Promise; /** * Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials. Required permissions: rolesanywhere:UpdateTrustAnchor. */ updateTrustAnchor(input: AWS.RolesAnywhere.UpdateTrustAnchorRequest, options: SdkCallOptions): Promise; } export interface Route53 { /** * Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE. */ activateKeySigningKey(input: AWS.Route53.ActivateKeySigningKeyRequest, options: SdkCallOptions): Promise; /** * Associates an Amazon VPC with a private hosted zone. To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone. If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request. When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition. The following are the supported partitions: aws - Amazon Web Services Regions aws-cn - China Regions aws-us-gov - Amazon Web Services GovCloud (US) Region For more information, see Access Management in the Amazon Web Services General Reference. */ associateVPCWithHostedZone(input: AWS.Route53.AssociateVPCWithHostedZoneRequest, options: SdkCallOptions): Promise; /** * Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations. A change request can update multiple locations in a collection at a time, which is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime. Limits The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API calls. PUT and DELETE_IF_EXISTS Use ChangeCidrCollection to perform the following actions: PUT: Create a CIDR block within the specified collection. DELETE_IF_EXISTS: Delete an existing CIDR block from the collection. */ changeCidrCollection(input: AWS.Route53.ChangeCidrCollectionRequest, options: SdkCallOptions): Promise; /** * Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44. Deleting Resource Record Sets To delete a resource record set, you must specify all the same values that you specified when you created it. Change Batches and Transactional Changes The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone. For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist. If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error. Traffic Flow To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide. Create, Delete, and Upsert Use ChangeResourceRecordsSetsRequest to perform the following actions: CREATE: Creates a resource record set that has the specified values. DELETE: Deletes an existing resource record set that has the specified values. UPSERT: If a resource set exists Route 53 updates it with the values in the request. Syntaxes for Creating, Updating, and Deleting Resource Record Sets The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. For an example for each type of resource record set, see "Examples." Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets. Change Propagation to Route 53 DNS Servers When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange. Limits on ChangeResourceRecordSets Requests For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide. */ changeResourceRecordSets(input: AWS.Route53.ChangeResourceRecordSetsRequest, options: SdkCallOptions): Promise; /** * Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide. */ changeTagsForResource(input: AWS.Route53.ChangeTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates a CIDR collection in the current Amazon Web Services account. */ createCidrCollection(input: AWS.Route53.CreateCidrCollectionRequest, options: SdkCallOptions): Promise; /** * Creates a new health check. For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets. ELB Load Balancers If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check. Private Hosted Zones You can associate health checks with failover resource record sets in a private hosted zone. Note the following: Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC. You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server. You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide. */ createHealthCheck(input: AWS.Route53.CreateHealthCheckRequest, options: SdkCallOptions): Promise; /** * Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets. For more information about charges for hosted zones, see Amazon Route 53 Pricing. Note the following: You can't create a hosted zone for a top-level domain (TLD) such as .com. For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide. If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element. If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide. When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC. The CreateHostedZone request requires the caller to have an ec2:DescribeVpcs permission. When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition. The following are the supported partitions: aws - Amazon Web Services Regions aws-cn - China Regions aws-us-gov - Amazon Web Services GovCloud (US) Region For more information, see Access Management in the Amazon Web Services General Reference. */ createHostedZone(input: AWS.Route53.CreateHostedZoneRequest, options: SdkCallOptions): Promise; /** * Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone. */ createKeySigningKey(input: AWS.Route53.CreateKeySigningKeyRequest, options: SdkCallOptions): Promise; /** * Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: Route 53 edge location that responded to the DNS query Domain or subdomain that was requested DNS record type, such as A or AAAA DNS response code, such as NoError or ServFail Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the Amazon Web Services IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI. Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. */ createQueryLoggingConfig(input: AWS.Route53.CreateQueryLoggingConfigRequest, options: SdkCallOptions): Promise; /** * Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account. You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request. You can't associate a reusable delegation set with a private hosted zone. For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers. The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps: Create a reusable delegation set. Recreate hosted zones, and reduce the TTL to 60 seconds or less. Recreate resource record sets in the new hosted zones. Change the registrar's name servers to use the name servers for the new hosted zones. Monitor traffic for the website or application. Change TTLs back to their original values. If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following: For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones. For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set. For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set. */ createReusableDelegationSet(input: AWS.Route53.CreateReusableDelegationSetRequest, options: SdkCallOptions): Promise; /** * Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). */ createTrafficPolicy(input: AWS.Route53.CreateTrafficPolicyRequest, options: SdkCallOptions): Promise; /** * Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created. */ createTrafficPolicyInstance(input: AWS.Route53.CreateTrafficPolicyInstanceRequest, options: SdkCallOptions): Promise; /** * Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy. */ createTrafficPolicyVersion(input: AWS.Route53.CreateTrafficPolicyVersionRequest, options: SdkCallOptions): Promise; /** * Authorizes the Amazon Web Services account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request. If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC. */ createVPCAssociationAuthorization(input: AWS.Route53.CreateVPCAssociationAuthorizationRequest, options: SdkCallOptions): Promise; /** * Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE. */ deactivateKeySigningKey(input: AWS.Route53.DeactivateKeySigningKeyRequest, options: SdkCallOptions): Promise; /** * Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted. */ deleteCidrCollection(input: AWS.Route53.DeleteCidrCollectionRequest, options: SdkCallOptions): Promise; /** * Deletes a health check. Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide. If you're using Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance, you can't use the Route 53 DeleteHealthCheck command to delete the health check. The health check is deleted automatically when you deregister the instance; there can be a delay of several hours before the health check is deleted from Route 53. */ deleteHealthCheck(input: AWS.Route53.DeleteHealthCheckRequest, options: SdkCallOptions): Promise; /** * Deletes a hosted zone. If the hosted zone was created by another service, such as Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.) If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone. If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name. If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on "free DNS service." You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets. To verify that the hosted zone has been deleted, do one of the following: Use the GetHostedZone action to request information about the hosted zone. Use the ListHostedZones action to get a list of the hosted zones associated with the current Amazon Web Services account. */ deleteHostedZone(input: AWS.Route53.DeleteHostedZoneRequest, options: SdkCallOptions): Promise; /** * Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing. You can use DeactivateKeySigningKey to deactivate the key before you delete it. Use GetDNSSEC to verify that the KSK is in an INACTIVE status. */ deleteKeySigningKey(input: AWS.Route53.DeleteKeySigningKeyRequest, options: SdkCallOptions): Promise; /** * Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs. For more information about DNS query logs, see CreateQueryLoggingConfig. */ deleteQueryLoggingConfig(input: AWS.Route53.DeleteQueryLoggingConfigRequest, options: SdkCallOptions): Promise; /** * Deletes a reusable delegation set. You can delete a reusable delegation set only if it isn't associated with any hosted zones. To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete. */ deleteReusableDelegationSet(input: AWS.Route53.DeleteReusableDelegationSetRequest, options: SdkCallOptions): Promise; /** * Deletes a traffic policy. When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53 never fully deletes the traffic policy. Note the following: Deleted traffic policies aren't listed if you run ListTrafficPolicies. There's no way to get a list of deleted policies. If you retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running GetTrafficPolicy. */ deleteTrafficPolicy(input: AWS.Route53.DeleteTrafficPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance. In the Route 53 console, traffic policy instances are known as policy records. */ deleteTrafficPolicyInstance(input: AWS.Route53.DeleteTrafficPolicyInstanceRequest, options: SdkCallOptions): Promise; /** * Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request. Sending this request only prevents the Amazon Web Services account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone. */ deleteVPCAssociationAuthorization(input: AWS.Route53.DeleteVPCAssociationAuthorizationRequest, options: SdkCallOptions): Promise; /** * Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone. */ disableHostedZoneDNSSEC(input: AWS.Route53.DisableHostedZoneDNSSECRequest, options: SdkCallOptions): Promise; /** * Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following: You can't disassociate the last Amazon VPC from a private hosted zone. You can't convert a private hosted zone into a public hosted zone. You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the Amazon VPC. Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account. When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for OwningAccount, you can use DisassociateVPCFromHostedZone. If the hosted zone has a value for OwningService, you can't use DisassociateVPCFromHostedZone. When revoking access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition. The following are the supported partitions: aws - Amazon Web Services Regions aws-cn - China Regions aws-us-gov - Amazon Web Services GovCloud (US) Region For more information, see Access Management in the Amazon Web Services General Reference. */ disassociateVPCFromHostedZone(input: AWS.Route53.DisassociateVPCFromHostedZoneRequest, options: SdkCallOptions): Promise; /** * Enables DNSSEC signing in a specific hosted zone. */ enableHostedZoneDNSSEC(input: AWS.Route53.EnableHostedZoneDNSSECRequest, options: SdkCallOptions): Promise; /** * Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane. */ getAccountLimit(input: AWS.Route53.GetAccountLimitRequest, options: SdkCallOptions): Promise; /** * Returns the current status of a change batch request. The status is one of the following values: PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests. INSYNC indicates that the changes have propagated to all Route 53 DNS servers. */ getChange(input: AWS.Route53.GetChangeRequest, options: SdkCallOptions): Promise; /** * Route 53 does not perform authorization for this API because it retrieves information that is already available to the public. GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all Amazon Web Services services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide. */ getCheckerIpRanges(input: AWS.Route53.GetCheckerIpRangesRequest, options: SdkCallOptions): Promise; /** * Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone. */ getDNSSEC(input: AWS.Route53.GetDNSSECRequest, options: SdkCallOptions): Promise; /** * Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets. Route 53 does not perform authorization for this API because it retrieves information that is already available to the public. Use the following syntax to determine whether a continent is supported for geolocation: GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent Use the following syntax to determine whether a country is supported for geolocation: GET /2013-04-01/geolocation?countrycode=two-character country code Use the following syntax to determine whether a subdivision of a country is supported for geolocation: GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code */ getGeoLocation(input: AWS.Route53.GetGeoLocationRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified health check. */ getHealthCheck(input: AWS.Route53.GetHealthCheckRequest, options: SdkCallOptions): Promise; /** * Retrieves the number of health checks that are associated with the current Amazon Web Services account. */ getHealthCheckCount(input: AWS.Route53.GetHealthCheckCountRequest, options: SdkCallOptions): Promise; /** * Gets the reason that a specified health check failed most recently. */ getHealthCheckLastFailureReason(input: AWS.Route53.GetHealthCheckLastFailureReasonRequest, options: SdkCallOptions): Promise; /** * Gets status of a specified health check. This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses. */ getHealthCheckStatus(input: AWS.Route53.GetHealthCheckStatusRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified hosted zone including the four name servers assigned to the hosted zone. */ getHostedZone(input: AWS.Route53.GetHostedZoneRequest, options: SdkCallOptions): Promise; /** * Retrieves the number of hosted zones that are associated with the current Amazon Web Services account. */ getHostedZoneCount(input: AWS.Route53.GetHostedZoneCountRequest, options: SdkCallOptions): Promise; /** * Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. */ getHostedZoneLimit(input: AWS.Route53.GetHostedZoneLimitRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified configuration for DNS query logging. For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries. */ getQueryLoggingConfig(input: AWS.Route53.GetQueryLoggingConfigRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set. */ getReusableDelegationSet(input: AWS.Route53.GetReusableDelegationSetRequest, options: SdkCallOptions): Promise; /** * Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set. For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case. */ getReusableDelegationSetLimit(input: AWS.Route53.GetReusableDelegationSetLimitRequest, options: SdkCallOptions): Promise; /** * Gets information about a specific traffic policy version. For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see DeleteTrafficPolicy. */ getTrafficPolicy(input: AWS.Route53.GetTrafficPolicyRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified traffic policy instance. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. In the Route 53 console, traffic policy instances are known as policy records. */ getTrafficPolicyInstance(input: AWS.Route53.GetTrafficPolicyInstanceRequest, options: SdkCallOptions): Promise; /** * Gets the number of traffic policy instances that are associated with the current Amazon Web Services account. */ getTrafficPolicyInstanceCount(input: AWS.Route53.GetTrafficPolicyInstanceCountRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of location objects and their CIDR blocks. */ listCidrBlocks(input: AWS.Route53.ListCidrBlocksRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only). */ listCidrCollections(input: AWS.Route53.ListCidrCollectionsRequest, options: SdkCallOptions): Promise; /** * Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks). */ listCidrLocations(input: AWS.Route53.ListCidrLocationsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of supported geographic locations. Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country. Route 53 does not perform authorization for this API because it retrieves information that is already available to the public. For a list of supported geolocation codes, see the GeoLocation data type. */ listGeoLocations(input: AWS.Route53.ListGeoLocationsRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of the health checks that are associated with the current Amazon Web Services account. */ listHealthChecks(input: AWS.Route53.ListHealthChecksRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a HostedZones child element for each hosted zone. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100. */ listHostedZones(input: AWS.Route53.ListHostedZonesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current Amazon Web Services account. ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example: com.example.www. Note the trailing dot, which can change the sort order in some circumstances. If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as: com.ex\344mple. The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide. Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next: The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response. The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response. If the value of IsTruncated in the response is true, there are more hosted zones associated with the current Amazon Web Services account. If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response. The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. */ listHostedZonesByName(input: AWS.Route53.ListHostedZonesByNameRequest, options: SdkCallOptions): Promise; /** * Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The HostedZoneOwner structure in the response contains one of the following values: An OwningAccount element, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account. An OwningService element, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of Owner is efs.amazonaws.com. When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition. The following are the supported partitions: aws - Amazon Web Services Regions aws-cn - China Regions aws-us-gov - Amazon Web Services GovCloud (US) Region For more information, see Access Management in the Amazon Web Services General Reference. */ listHostedZonesByVPC(input: AWS.Route53.ListHostedZonesByVPCRequest, options: SdkCallOptions): Promise; /** * Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone. For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide. */ listQueryLoggingConfigs(input: AWS.Route53.ListQueryLoggingConfigsRequest, options: SdkCallOptions): Promise; /** * Lists the resource record sets in a specified hosted zone. ListResourceRecordSets returns up to 300 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. Sort order ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example: com.example.www. Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! " # $ % & ' ( ) * + , - When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type. Specifying where to start listing records You can use the name and type elements to specify the resource record set that the list begins with: If you do not specify Name or Type The results begin with the first resource record set that the hosted zone contains. If you specify Name but not Type The results begin with the first resource record set in the list whose name is greater than or equal to Name. If you specify Type but not Name Amazon Route 53 returns the InvalidInput error. If you specify both Name and Type The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type. Resource record sets that are PENDING This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers. Changing resource record sets To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes. Displaying the next page of results If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName, StartRecordType, and StartRecordIdentifier. */ listResourceRecordSets(input: AWS.Route53.ListResourceRecordSetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account. */ listReusableDelegationSets(input: AWS.Route53.ListReusableDelegationSetsRequest, options: SdkCallOptions): Promise; /** * Lists tags for one health check or hosted zone. For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide. */ listTagsForResource(input: AWS.Route53.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists tags for up to 10 health checks or hosted zones. For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide. */ listTagsForResources(input: AWS.Route53.ListTagsForResourcesRequest, options: SdkCallOptions): Promise; /** * Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in. For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see DeleteTrafficPolicy. */ listTrafficPolicies(input: AWS.Route53.ListTrafficPoliciesRequest, options: SdkCallOptions): Promise; /** * Gets information about the traffic policy instances that you created by using the current Amazon Web Services account. After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. */ listTrafficPolicyInstances(input: AWS.Route53.ListTrafficPolicyInstancesRequest, options: SdkCallOptions): Promise; /** * Gets information about the traffic policy instances that you created in a specified hosted zone. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. */ listTrafficPolicyInstancesByHostedZone(input: AWS.Route53.ListTrafficPolicyInstancesByHostedZoneRequest, options: SdkCallOptions): Promise; /** * Gets information about the traffic policy instances that you created by using a specify traffic policy version. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100. */ listTrafficPolicyInstancesByPolicy(input: AWS.Route53.ListTrafficPolicyInstancesByPolicyRequest, options: SdkCallOptions): Promise; /** * Gets information about all of the versions for a specified traffic policy. Traffic policy versions are listed in numerical order by VersionNumber. */ listTrafficPolicyVersions(input: AWS.Route53.ListTrafficPolicyVersionsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests. The response includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone. */ listVPCAssociationAuthorizations(input: AWS.Route53.ListVPCAssociationAuthorizationsRequest, options: SdkCallOptions): Promise; /** * Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. This call only supports querying public hosted zones. */ testDNSAnswer(input: AWS.Route53.TestDNSAnswerRequest, options: SdkCallOptions): Promise; /** * Updates an existing health check. Note that some values can't be updated. For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide. */ updateHealthCheck(input: AWS.Route53.UpdateHealthCheckRequest, options: SdkCallOptions): Promise; /** * Updates the comment for a specified hosted zone. */ updateHostedZoneComment(input: AWS.Route53.UpdateHostedZoneCommentRequest, options: SdkCallOptions): Promise; /** * Updates the comment for a specified traffic policy version. */ updateTrafficPolicyComment(input: AWS.Route53.UpdateTrafficPolicyCommentRequest, options: SdkCallOptions): Promise; /** * Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version. When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations: Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets. When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets. Route 53 deletes the old group of resource record sets that are associated with the root resource record set name. */ updateTrafficPolicyInstance(input: AWS.Route53.UpdateTrafficPolicyInstanceRequest, options: SdkCallOptions): Promise; } export interface Route53Domains { /** * Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount. If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text because otherwise CLI will throw an error from domain transfer input that includes single quotes. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. */ acceptDomainTransferFromAnotherAwsAccount(input: AWS.Route53Domains.AcceptDomainTransferFromAnotherAwsAccountRequest, options: SdkCallOptions): Promise; /** * Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount. You must cancel the transfer before the other Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. */ cancelDomainTransferToAnotherAwsAccount(input: AWS.Route53Domains.CancelDomainTransferToAnotherAwsAccountRequest, options: SdkCallOptions): Promise; /** * This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. */ checkDomainAvailability(input: AWS.Route53Domains.CheckDomainAvailabilityRequest, options: SdkCallOptions): Promise; /** * Checks whether a domain name can be transferred to Amazon Route 53. */ checkDomainTransferability(input: AWS.Route53Domains.CheckDomainTransferabilityRequest, options: SdkCallOptions): Promise; /** * This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name registration. To transfer the domain registration to another registrar, use the transfer process that’s provided by the registrar to which you want to transfer the registration. Otherwise, the following apply: You can’t get a refund for the cost of a deleted domain registration. The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry). When the registration has been deleted, we'll send you a confirmation to the registrant contact. The email will come from noreply@domainnameverification.net or noreply@registrar.amazon.com. */ deleteDomain(input: AWS.Route53Domains.DeleteDomainRequest, options: SdkCallOptions): Promise; /** * This operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. */ deleteTagsForDomain(input: AWS.Route53Domains.DeleteTagsForDomainRequest, options: SdkCallOptions): Promise; /** * This operation disables automatic renewal of domain registration for the specified domain. */ disableDomainAutoRenew(input: AWS.Route53Domains.DisableDomainAutoRenewRequest, options: SdkCallOptions): Promise; /** * This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. */ disableDomainTransferLock(input: AWS.Route53Domains.DisableDomainTransferLockRequest, options: SdkCallOptions): Promise; /** * This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your Amazon Web Services account. The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period so we can complete processing before the deadline. */ enableDomainAutoRenew(input: AWS.Route53Domains.EnableDomainAutoRenewRequest, options: SdkCallOptions): Promise; /** * This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. */ enableDomainTransferLock(input: AWS.Route53Domains.EnableDomainTransferLockRequest, options: SdkCallOptions): Promise; /** * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded. If you want us to resend the email, use the ResendContactReachabilityEmail operation. */ getContactReachabilityStatus(input: AWS.Route53Domains.GetContactReachabilityStatusRequest, options: SdkCallOptions): Promise; /** * This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. Contact information for the domain is also returned as part of the output. */ getDomainDetail(input: AWS.Route53Domains.GetDomainDetailRequest, options: SdkCallOptions): Promise; /** * The GetDomainSuggestions operation returns a list of suggested domain names. */ getDomainSuggestions(input: AWS.Route53Domains.GetDomainSuggestionsRequest, options: SdkCallOptions): Promise; /** * This operation returns the current status of an operation that is not completed. */ getOperationDetail(input: AWS.Route53Domains.GetOperationDetailRequest, options: SdkCallOptions): Promise; /** * This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used. */ listDomains(input: AWS.Route53Domains.ListDomainsRequest, options: SdkCallOptions): Promise; /** * Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account. This command runs only in the us-east-1 Region. */ listOperations(input: AWS.Route53Domains.ListOperationsRequest, options: SdkCallOptions): Promise; /** * Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD: Registration Transfer Owner change Domain renewal Domain restoration */ listPrices(input: AWS.Route53Domains.ListPricesRequest, options: SdkCallOptions): Promise; /** * This operation returns all of the tags that are associated with the specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. */ listTagsForDomain(input: AWS.Route53Domains.ListTagsForDomainRequest, options: SdkCallOptions): Promise; /** * This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters. When you register a domain, Amazon Route 53 does the following: Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers. Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration. Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts. You must specify the same privacy setting for the administrative, registrant, and technical contacts. If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email. Charges your Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing. */ registerDomain(input: AWS.Route53Domains.RegisterDomainRequest, options: SdkCallOptions): Promise; /** * Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. */ rejectDomainTransferFromAnotherAwsAccount(input: AWS.Route53Domains.RejectDomainTransferFromAnotherAwsAccountRequest, options: SdkCallOptions): Promise; /** * This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services account. We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide. */ renewDomain(input: AWS.Route53Domains.RenewDomainRequest, options: SdkCallOptions): Promise; /** * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact. */ resendContactReachabilityEmail(input: AWS.Route53Domains.ResendContactReachabilityEmailRequest, options: SdkCallOptions): Promise; /** * This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. */ retrieveDomainAuthCode(input: AWS.Route53Domains.RetrieveDomainAuthCodeRequest, options: SdkCallOptions): Promise; /** * Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs). For more information about transferring domains, see the following topics: For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide. For information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount. For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide. If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable. If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email. */ transferDomain(input: AWS.Route53Domains.TransferDomainRequest, options: SdkCallOptions): Promise; /** * Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following: The Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount. You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount. The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount. When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see Migrating a Hosted Zone to a Different Amazon Web Services Account in the Amazon Route 53 Developer Guide. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. */ transferDomainToAnotherAwsAccount(input: AWS.Route53Domains.TransferDomainToAnotherAwsAccountRequest, options: SdkCallOptions): Promise; /** * This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical. If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. */ updateDomainContact(input: AWS.Route53Domains.UpdateDomainContactRequest, options: SdkCallOptions): Promise; /** * This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi. You must specify the same privacy setting for the administrative, registrant, and technical contacts. This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email. By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. For more information on our privacy practices, see https://aws.amazon.com/privacy/. */ updateDomainContactPrivacy(input: AWS.Route53Domains.UpdateDomainContactPrivacyRequest, options: SdkCallOptions): Promise; /** * This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. */ updateDomainNameservers(input: AWS.Route53Domains.UpdateDomainNameserversRequest, options: SdkCallOptions): Promise; /** * This operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. */ updateTagsForDomain(input: AWS.Route53Domains.UpdateTagsForDomainRequest, options: SdkCallOptions): Promise; /** * Returns all the domain-related billing records for the current Amazon Web Services account for a specified period */ viewBilling(input: AWS.Route53Domains.ViewBillingRequest, options: SdkCallOptions): Promise; } export interface Route53RecoveryCluster { /** * Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow. Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing control states Working with routing controls in Route 53 ARC */ getRoutingControlState(input: AWS.Route53RecoveryCluster.GetRoutingControlStateRequest, options: SdkCallOptions): Promise; /** * List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster. A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow. Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC. Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing control states Working with routing controls in Route 53 ARC */ listRoutingControls(input: AWS.Route53RecoveryCluster.ListRoutingControlsRequest, options: SdkCallOptions): Promise; /** * Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When the state is Off, traffic does not flow. With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application. The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Viewing and updating routing control states Working with routing controls overall */ updateRoutingControlState(input: AWS.Route53RecoveryCluster.UpdateRoutingControlStateRequest, options: SdkCallOptions): Promise; /** * Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow. With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application. The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide. You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC. To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide. Viewing and updating routing control states Working with routing controls overall */ updateRoutingControlStates(input: AWS.Route53RecoveryCluster.UpdateRoutingControlStatesRequest, options: SdkCallOptions): Promise; } export interface Route53RecoveryControlConfig { /** * Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane. */ createCluster(input: AWS.Route53RecoveryControlConfig.CreateClusterRequest, options: SdkCallOptions): Promise; /** * Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region. */ createControlPanel(input: AWS.Route53RecoveryControlConfig.CreateControlPanelRequest, options: SdkCallOptions): Promise; /** * Creates a new routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller. */ createRoutingControl(input: AWS.Route53RecoveryControlConfig.CreateRoutingControlRequest, options: SdkCallOptions): Promise; /** * Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes. There are two types of safety rules: assertion rules and gating rules. Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transation so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario. Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls. For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide. */ createSafetyRule(input: AWS.Route53RecoveryControlConfig.CreateSafetyRuleRequest, options: SdkCallOptions): Promise; /** * Delete a cluster. */ deleteCluster(input: AWS.Route53RecoveryControlConfig.DeleteClusterRequest, options: SdkCallOptions): Promise; /** * Deletes a control panel. */ deleteControlPanel(input: AWS.Route53RecoveryControlConfig.DeleteControlPanelRequest, options: SdkCallOptions): Promise; /** * Deletes a routing control. */ deleteRoutingControl(input: AWS.Route53RecoveryControlConfig.DeleteRoutingControlRequest, options: SdkCallOptions): Promise; /** * Deletes a safety rule./> */ deleteSafetyRule(input: AWS.Route53RecoveryControlConfig.DeleteSafetyRuleRequest, options: SdkCallOptions): Promise; /** * Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN). */ describeCluster(input: AWS.Route53RecoveryControlConfig.DescribeClusterRequest, options: SdkCallOptions): Promise; /** * Displays details about a control panel. */ describeControlPanel(input: AWS.Route53RecoveryControlConfig.DescribeControlPanelRequest, options: SdkCallOptions): Promise; /** * Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller. */ describeRoutingControl(input: AWS.Route53RecoveryControlConfig.DescribeRoutingControlRequest, options: SdkCallOptions): Promise; /** * Returns information about a safety rule. */ describeSafetyRule(input: AWS.Route53RecoveryControlConfig.DescribeSafetyRuleRequest, options: SdkCallOptions): Promise; /** * Returns an array of all Amazon Route 53 health checks associated with a specific routing control. */ listAssociatedRoute53HealthChecks(input: AWS.Route53RecoveryControlConfig.ListAssociatedRoute53HealthChecksRequest, options: SdkCallOptions): Promise; /** * Returns an array of all the clusters in an account. */ listClusters(input: AWS.Route53RecoveryControlConfig.ListClustersRequest, options: SdkCallOptions): Promise; /** * Returns an array of control panels in an account or in a cluster. */ listControlPanels(input: AWS.Route53RecoveryControlConfig.ListControlPanelsRequest, options: SdkCallOptions): Promise; /** * Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing. */ listRoutingControls(input: AWS.Route53RecoveryControlConfig.ListRoutingControlsRequest, options: SdkCallOptions): Promise; /** * List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel. */ listSafetyRules(input: AWS.Route53RecoveryControlConfig.ListSafetyRulesRequest, options: SdkCallOptions): Promise; /** * Lists the tags for a resource. */ listTagsForResource(input: AWS.Route53RecoveryControlConfig.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds a tag to a resource. */ tagResource(input: AWS.Route53RecoveryControlConfig.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from a resource. */ untagResource(input: AWS.Route53RecoveryControlConfig.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a control panel. The only update you can make to a control panel is to change the name of the control panel. */ updateControlPanel(input: AWS.Route53RecoveryControlConfig.UpdateControlPanelRequest, options: SdkCallOptions): Promise; /** * Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller. */ updateRoutingControl(input: AWS.Route53RecoveryControlConfig.UpdateRoutingControlRequest, options: SdkCallOptions): Promise; /** * Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one. */ updateSafetyRule(input: AWS.Route53RecoveryControlConfig.UpdateSafetyRuleRequest, options: SdkCallOptions): Promise; } export interface Route53RecoveryReadiness { /** * Creates a cell in an account. */ createCell(input: AWS.Route53RecoveryReadiness.CreateCellRequest, options: SdkCallOptions): Promise; /** * Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account. */ createCrossAccountAuthorization(input: AWS.Route53RecoveryReadiness.CreateCrossAccountAuthorizationRequest, options: SdkCallOptions): Promise; /** * Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check. */ createReadinessCheck(input: AWS.Route53RecoveryReadiness.CreateReadinessCheckRequest, options: SdkCallOptions): Promise; /** * Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application. */ createRecoveryGroup(input: AWS.Route53RecoveryReadiness.CreateRecoveryGroupRequest, options: SdkCallOptions): Promise; /** * Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness. */ createResourceSet(input: AWS.Route53RecoveryReadiness.CreateResourceSetRequest, options: SdkCallOptions): Promise; /** * Delete a cell. When successful, the response code is 204, with no response body. */ deleteCell(input: AWS.Route53RecoveryReadiness.DeleteCellRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes cross account readiness authorization. */ deleteCrossAccountAuthorization(input: AWS.Route53RecoveryReadiness.DeleteCrossAccountAuthorizationRequest, options: SdkCallOptions): Promise; /** * Deletes a readiness check. */ deleteReadinessCheck(input: AWS.Route53RecoveryReadiness.DeleteReadinessCheckRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a recovery group. */ deleteRecoveryGroup(input: AWS.Route53RecoveryReadiness.DeleteRecoveryGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a resource set. */ deleteResourceSet(input: AWS.Route53RecoveryReadiness.DeleteResourceSetRequest, options: SdkCallOptions): Promise<{}>; /** * Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group. */ getArchitectureRecommendations(input: AWS.Route53RecoveryReadiness.GetArchitectureRecommendationsRequest, options: SdkCallOptions): Promise; /** * Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs. */ getCell(input: AWS.Route53RecoveryReadiness.GetCellRequest, options: SdkCallOptions): Promise; /** * Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value. */ getCellReadinessSummary(input: AWS.Route53RecoveryReadiness.GetCellReadinessSummaryRequest, options: SdkCallOptions): Promise; /** * Gets details about a readiness check. */ getReadinessCheck(input: AWS.Route53RecoveryReadiness.GetReadinessCheckRequest, options: SdkCallOptions): Promise; /** * Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary. */ getReadinessCheckResourceStatus(input: AWS.Route53RecoveryReadiness.GetReadinessCheckResourceStatusRequest, options: SdkCallOptions): Promise; /** * Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary. */ getReadinessCheckStatus(input: AWS.Route53RecoveryReadiness.GetReadinessCheckStatusRequest, options: SdkCallOptions): Promise; /** * Gets details about a recovery group, including a list of the cells that are included in it. */ getRecoveryGroup(input: AWS.Route53RecoveryReadiness.GetRecoveryGroupRequest, options: SdkCallOptions): Promise; /** * Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one. */ getRecoveryGroupReadinessSummary(input: AWS.Route53RecoveryReadiness.GetRecoveryGroupReadinessSummaryRequest, options: SdkCallOptions): Promise; /** * Displays the details about a resource set, including a list of the resources in the set. */ getResourceSet(input: AWS.Route53RecoveryReadiness.GetResourceSetRequest, options: SdkCallOptions): Promise; /** * Lists the cells for an account. */ listCells(input: AWS.Route53RecoveryReadiness.ListCellsRequest, options: SdkCallOptions): Promise; /** * Lists the cross-account readiness authorizations that are in place for an account. */ listCrossAccountAuthorizations(input: AWS.Route53RecoveryReadiness.ListCrossAccountAuthorizationsRequest, options: SdkCallOptions): Promise; /** * Lists the readiness checks for an account. */ listReadinessChecks(input: AWS.Route53RecoveryReadiness.ListReadinessChecksRequest, options: SdkCallOptions): Promise; /** * Lists the recovery groups in an account. */ listRecoveryGroups(input: AWS.Route53RecoveryReadiness.ListRecoveryGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the resource sets in an account. */ listResourceSets(input: AWS.Route53RecoveryReadiness.ListResourceSetsRequest, options: SdkCallOptions): Promise; /** * Lists all readiness rules, or lists the readiness rules for a specific resource type. */ listRules(input: AWS.Route53RecoveryReadiness.ListRulesRequest, options: SdkCallOptions): Promise; /** * Lists the tags for a resource. */ listTagsForResources(input: AWS.Route53RecoveryReadiness.ListTagsForResourcesRequest, options: SdkCallOptions): Promise; /** * Adds a tag to a resource. */ tagResource(input: AWS.Route53RecoveryReadiness.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from a resource. */ untagResource(input: AWS.Route53RecoveryReadiness.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a cell to replace the list of nested cells with a new list of nested cells. */ updateCell(input: AWS.Route53RecoveryReadiness.UpdateCellRequest, options: SdkCallOptions): Promise; /** * Updates a readiness check. */ updateReadinessCheck(input: AWS.Route53RecoveryReadiness.UpdateReadinessCheckRequest, options: SdkCallOptions): Promise; /** * Updates a recovery group. */ updateRecoveryGroup(input: AWS.Route53RecoveryReadiness.UpdateRecoveryGroupRequest, options: SdkCallOptions): Promise; /** * Updates a resource set. */ updateResourceSet(input: AWS.Route53RecoveryReadiness.UpdateResourceSetRequest, options: SdkCallOptions): Promise; } export interface Route53Resolver { /** * Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC. */ associateFirewallRuleGroup(input: AWS.Route53Resolver.AssociateFirewallRuleGroupRequest, options: SdkCallOptions): Promise; /** * Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address. To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress. */ associateResolverEndpointIpAddress(input: AWS.Route53Resolver.AssociateResolverEndpointIpAddressRequest, options: SdkCallOptions): Promise; /** * Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig request for each VPC. The VPCs that you associate with a query logging configuration must be in the same Region as the configuration. To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig. */ associateResolverQueryLogConfig(input: AWS.Route53Resolver.AssociateResolverQueryLogConfigRequest, options: SdkCallOptions): Promise; /** * Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule. */ associateResolverRule(input: AWS.Route53Resolver.AssociateResolverRuleRequest, options: SdkCallOptions): Promise; /** * Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains. */ createFirewallDomainList(input: AWS.Route53Resolver.CreateFirewallDomainListRequest, options: SdkCallOptions): Promise; /** * Creates a single DNS Firewall rule in the specified rule group, using the specified domain list. */ createFirewallRule(input: AWS.Route53Resolver.CreateFirewallRuleRequest, options: SdkCallOptions): Promise; /** * Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule. */ createFirewallRuleGroup(input: AWS.Route53Resolver.CreateFirewallRuleGroupRequest, options: SdkCallOptions): Promise; /** * Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound: An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC from your network. An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network. */ createResolverEndpoint(input: AWS.Route53Resolver.CreateResolverEndpointRequest, options: SdkCallOptions): Promise; /** * Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration. To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see AssociateResolverQueryLogConfig. You can optionally use Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration. */ createResolverQueryLogConfig(input: AWS.Route53Resolver.CreateResolverQueryLogConfigRequest, options: SdkCallOptions): Promise; /** * For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network. */ createResolverRule(input: AWS.Route53Resolver.CreateResolverRuleRequest, options: SdkCallOptions): Promise; /** * Deletes the specified domain list. */ deleteFirewallDomainList(input: AWS.Route53Resolver.DeleteFirewallDomainListRequest, options: SdkCallOptions): Promise; /** * Deletes the specified firewall rule. */ deleteFirewallRule(input: AWS.Route53Resolver.DeleteFirewallRuleRequest, options: SdkCallOptions): Promise; /** * Deletes the specified firewall rule group. */ deleteFirewallRuleGroup(input: AWS.Route53Resolver.DeleteFirewallRuleGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound Resolver endpoint: Inbound: DNS queries from your network are no longer routed to the DNS service for the specified VPC. Outbound: DNS queries from a VPC are no longer routed to your network. */ deleteResolverEndpoint(input: AWS.Route53Resolver.DeleteResolverEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and the other accounts have associated VPCs with the shared configuration. Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration. */ deleteResolverQueryLogConfig(input: AWS.Route53Resolver.DeleteResolverQueryLogConfigRequest, options: SdkCallOptions): Promise; /** * Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you associated the Resolver rule with. For more information, see DisassociateResolverRule. */ deleteResolverRule(input: AWS.Route53Resolver.DeleteResolverRuleRequest, options: SdkCallOptions): Promise; /** * Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC. */ disassociateFirewallRuleGroup(input: AWS.Route53Resolver.DisassociateFirewallRuleGroupRequest, options: SdkCallOptions): Promise; /** * Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address. To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress. */ disassociateResolverEndpointIpAddress(input: AWS.Route53Resolver.DisassociateResolverEndpointIpAddressRequest, options: SdkCallOptions): Promise; /** * Disassociates a VPC from a query logging configuration. Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways: The accounts that you shared the configuration with can disassociate VPCs from the configuration. You can stop sharing the configuration. */ disassociateResolverQueryLogConfig(input: AWS.Route53Resolver.DisassociateResolverQueryLogConfigRequest, options: SdkCallOptions): Promise; /** * Removes the association between a specified Resolver rule and a specified VPC. If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the Resolver rule. */ disassociateResolverRule(input: AWS.Route53Resolver.DisassociateResolverRuleRequest, options: SdkCallOptions): Promise; /** * Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC). */ getFirewallConfig(input: AWS.Route53Resolver.GetFirewallConfigRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified firewall domain list. */ getFirewallDomainList(input: AWS.Route53Resolver.GetFirewallDomainListRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified firewall rule group. */ getFirewallRuleGroup(input: AWS.Route53Resolver.GetFirewallRuleGroupRequest, options: SdkCallOptions): Promise; /** * Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC. */ getFirewallRuleGroupAssociation(input: AWS.Route53Resolver.GetFirewallRuleGroupAssociationRequest, options: SdkCallOptions): Promise; /** * Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM). */ getFirewallRuleGroupPolicy(input: AWS.Route53Resolver.GetFirewallRuleGroupPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud. */ getResolverConfig(input: AWS.Route53Resolver.GetResolverConfigRequest, options: SdkCallOptions): Promise; /** * Gets DNSSEC validation information for a specified resource. */ getResolverDnssecConfig(input: AWS.Route53Resolver.GetResolverDnssecConfigRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint. */ getResolverEndpoint(input: AWS.Route53Resolver.GetResolverEndpointRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to. */ getResolverQueryLogConfig(input: AWS.Route53Resolver.GetResolverQueryLogConfigRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC. */ getResolverQueryLogConfigAssociation(input: AWS.Route53Resolver.GetResolverQueryLogConfigAssociationRequest, options: SdkCallOptions): Promise; /** * Gets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow another Amazon Web Services account to be able to use. */ getResolverQueryLogConfigPolicy(input: AWS.Route53Resolver.GetResolverQueryLogConfigPolicyRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with. */ getResolverRule(input: AWS.Route53Resolver.GetResolverRuleRequest, options: SdkCallOptions): Promise; /** * Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using AssociateResolverRule. */ getResolverRuleAssociation(input: AWS.Route53Resolver.GetResolverRuleAssociationRequest, options: SdkCallOptions): Promise; /** * Gets information about the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share with another account, the account that you want to share the rule with, and the Resolver operations that you want to allow the account to use. */ getResolverRulePolicy(input: AWS.Route53Resolver.GetResolverRulePolicyRequest, options: SdkCallOptions): Promise; /** * Imports domain names from a file into a domain list, for use in a DNS firewall rule group. Each domain specification in your domain list must satisfy the following requirements: It can optionally start with * (asterisk). With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen). It must be from 1-255 characters in length. */ importFirewallDomains(input: AWS.Route53Resolver.ImportFirewallDomainsRequest, options: SdkCallOptions): Promise; /** * Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs. A single call might return only a partial list of the configurations. For information, see MaxResults. */ listFirewallConfigs(input: AWS.Route53Resolver.ListFirewallConfigsRequest, options: SdkCallOptions): Promise; /** * Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains. A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults. */ listFirewallDomainLists(input: AWS.Route53Resolver.ListFirewallDomainListsRequest, options: SdkCallOptions): Promise; /** * Retrieves the domains that you have defined for the specified firewall domain list. A single call might return only a partial list of the domains. For information, see MaxResults. */ listFirewallDomains(input: AWS.Route53Resolver.ListFirewallDomainsRequest, options: SdkCallOptions): Promise; /** * Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group. A single call might return only a partial list of the associations. For information, see MaxResults. */ listFirewallRuleGroupAssociations(input: AWS.Route53Resolver.ListFirewallRuleGroupAssociationsRequest, options: SdkCallOptions): Promise; /** * Retrieves the minimal high-level information for the rule groups that you have defined. A single call might return only a partial list of the rule groups. For information, see MaxResults. */ listFirewallRuleGroups(input: AWS.Route53Resolver.ListFirewallRuleGroupsRequest, options: SdkCallOptions): Promise; /** * Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC. A single call might return only a partial list of the rules. For information, see MaxResults. */ listFirewallRules(input: AWS.Route53Resolver.ListFirewallRulesRequest, options: SdkCallOptions): Promise; /** * Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs. */ listResolverConfigs(input: AWS.Route53Resolver.ListResolverConfigsRequest, options: SdkCallOptions): Promise; /** * Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account. */ listResolverDnssecConfigs(input: AWS.Route53Resolver.ListResolverDnssecConfigsRequest, options: SdkCallOptions): Promise; /** * Gets the IP addresses for a specified Resolver endpoint. */ listResolverEndpointIpAddresses(input: AWS.Route53Resolver.ListResolverEndpointIpAddressesRequest, options: SdkCallOptions): Promise; /** * Lists all the Resolver endpoints that were created using the current Amazon Web Services account. */ listResolverEndpoints(input: AWS.Route53Resolver.ListResolverEndpointsRequest, options: SdkCallOptions): Promise; /** * Lists information about associations between Amazon VPCs and query logging configurations. */ listResolverQueryLogConfigAssociations(input: AWS.Route53Resolver.ListResolverQueryLogConfigAssociationsRequest, options: SdkCallOptions): Promise; /** * Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for. */ listResolverQueryLogConfigs(input: AWS.Route53Resolver.ListResolverQueryLogConfigsRequest, options: SdkCallOptions): Promise; /** * Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account. */ listResolverRuleAssociations(input: AWS.Route53Resolver.ListResolverRuleAssociationsRequest, options: SdkCallOptions): Promise; /** * Lists the Resolver rules that were created using the current Amazon Web Services account. */ listResolverRules(input: AWS.Route53Resolver.ListResolverRulesRequest, options: SdkCallOptions): Promise; /** * Lists the tags that you associated with the specified resource. */ listTagsForResource(input: AWS.Route53Resolver.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Resource Access Manager (RAM). */ putFirewallRuleGroupPolicy(input: AWS.Route53Resolver.PutFirewallRuleGroupPolicyRequest, options: SdkCallOptions): Promise; /** * Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration. */ putResolverQueryLogConfigPolicy(input: AWS.Route53Resolver.PutResolverQueryLogConfigPolicyRequest, options: SdkCallOptions): Promise; /** * Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule. */ putResolverRulePolicy(input: AWS.Route53Resolver.PutResolverRulePolicyRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to a specified resource. */ tagResource(input: AWS.Route53Resolver.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a specified resource. */ untagResource(input: AWS.Route53Resolver.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC). */ updateFirewallConfig(input: AWS.Route53Resolver.UpdateFirewallConfigRequest, options: SdkCallOptions): Promise; /** * Updates the firewall domain list from an array of domain specifications. */ updateFirewallDomains(input: AWS.Route53Resolver.UpdateFirewallDomainsRequest, options: SdkCallOptions): Promise; /** * Updates the specified firewall rule. */ updateFirewallRule(input: AWS.Route53Resolver.UpdateFirewallRuleRequest, options: SdkCallOptions): Promise; /** * Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC. */ updateFirewallRuleGroupAssociation(input: AWS.Route53Resolver.UpdateFirewallRuleGroupAssociationRequest, options: SdkCallOptions): Promise; /** * Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud. */ updateResolverConfig(input: AWS.Route53Resolver.UpdateResolverConfigRequest, options: SdkCallOptions): Promise; /** * Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created. */ updateResolverDnssecConfig(input: AWS.Route53Resolver.UpdateResolverDnssecConfigRequest, options: SdkCallOptions): Promise; /** * Updates the name of an inbound or an outbound Resolver endpoint. */ updateResolverEndpoint(input: AWS.Route53Resolver.UpdateResolverEndpointRequest, options: SdkCallOptions): Promise; /** * Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value. */ updateResolverRule(input: AWS.Route53Resolver.UpdateResolverRuleRequest, options: SdkCallOptions): Promise; } export interface RUM { /** * Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior. You use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor instead. After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated? */ createAppMonitor(input: AWS.RUM.CreateAppMonitorRequest, options: SdkCallOptions): Promise; /** * Deletes an existing app monitor. This immediately stops the collection of data. */ deleteAppMonitor(input: AWS.RUM.DeleteAppMonitorRequest, options: SdkCallOptions): Promise; /** * Retrieves the complete configuration information for one app monitor. */ getAppMonitor(input: AWS.RUM.GetAppMonitorRequest, options: SdkCallOptions): Promise; /** * Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data. */ getAppMonitorData(input: AWS.RUM.GetAppMonitorDataRequest, options: SdkCallOptions): Promise; /** * Returns a list of the Amazon CloudWatch RUM app monitors in the account. */ listAppMonitors(input: AWS.RUM.ListAppMonitorsRequest, options: SdkCallOptions): Promise; /** * Displays the tags associated with a CloudWatch RUM resource. */ listTagsForResource(input: AWS.RUM.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents operations to send this data to RUM. Each PutRumEvents operation can send a batch of events from one user session. */ putRumEvents(input: AWS.RUM.PutRumEventsRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. For more information, see Tagging Amazon Web Services resources. */ tagResource(input: AWS.RUM.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. */ untagResource(input: AWS.RUM.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept. You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use TagResource. To create a new app monitor, use CreateAppMonitor. After you update an app monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated? */ updateAppMonitor(input: AWS.RUM.UpdateAppMonitorRequest, options: SdkCallOptions): Promise; } export interface S3 { /** * This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that the parts list is empty. For information about permissions required to use the multipart upload, see Multipart Upload and Permissions. The following operations are related to AbortMultipartUpload: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts ListMultipartUploads */ abortMultipartUpload(input: AWS.S3.AbortMultipartUploadRequest, options: SdkCallOptions): Promise; /** * Completes a multipart upload by assembling previously uploaded parts. You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded. Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded. Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices. You cannot use Content-Type: application/x-www-form-urlencoded with Complete Multipart Upload requests. Also, if you do not provide a Content-Type header, CompleteMultipartUpload returns a 200 OK response. For more information about multipart uploads, see Uploading Objects Using Multipart Upload. For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions. CompleteMultipartUpload has the following special errors: Error code: EntityTooSmall Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part. 400 Bad Request Error code: InvalidPart Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag. 400 Bad Request Error code: InvalidPartOrder Description: The list of parts was not in ascending order. The parts list must be specified in order by part number. 400 Bad Request Error code: NoSuchUpload Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. 404 Not Found The following operations are related to CompleteMultipartUpload: CreateMultipartUpload UploadPart AbortMultipartUpload ListParts ListMultipartUploads */ completeMultipartUpload(input: AWS.S3.CompleteMultipartUploadRequest, options: SdkCallOptions): Promise; /** * Creates a copy of an object that is already stored in Amazon S3. You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API. All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body. The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing. Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration. Metadata When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs. To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3. x-amz-copy-source-if Headers To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters: x-amz-copy-source-if-match x-amz-copy-source-if-none-match x-amz-copy-source-if-unmodified-since x-amz-copy-source-if-modified-since If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data: x-amz-copy-source-if-match condition evaluates to true x-amz-copy-source-if-unmodified-since condition evaluates to false If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code: x-amz-copy-source-if-none-match condition evaluates to false x-amz-copy-source-if-modified-since condition evaluates to true All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. Server-side encryption When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption. If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. Access Control List (ACL)-Specific Request Headers When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API. If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner. Checksums When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Storage Class Options You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide. Versioning By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource. If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response. If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null. If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject. The following operations are related to CopyObject: PutObject GetObject For more information, see Copying Objects. */ copyObject(input: AWS.S3.CopyObjectRequest, options: SdkCallOptions): Promise; /** * Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner. Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules. If you want to create an Amazon S3 on Outposts bucket, see Create Bucket. By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket. If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets. Access control lists (ACLs) When creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or groups that should be granted specific permissions on the bucket. If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 error and returns the InvalidBucketAclWithObjectOwnership error code. For more information, see Controlling object ownership in the Amazon S3 User Guide. There are two ways to grant the appropriate permissions using the request headers. Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access control list (ACL) overview. You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an Amazon Web Services account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an Amazon Web Services account Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata: x-amz-grant-read: id="11112222333", id="444455556666" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Permissions In addition to s3:CreateBucket, the following permissions are required when your CreateBucket includes specific headers: ACLs - If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the CreateBucket request is private or doesn't specify any ACLs, only s3:CreateBucket permission is needed. Object Lock - If ObjectLockEnabledForBucket is set to true in your CreateBucket request, s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required. S3 Object Ownership - If your CreateBucket request includes the the x-amz-object-ownership header, s3:PutBucketOwnershipControls permission is required. The following operations are related to CreateBucket: PutObject DeleteBucket */ createBucket(input: AWS.S3.CreateBucketRequest, options: SdkCallOptions): Promise; /** * This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview. If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions. For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4). After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions in the Amazon S3 User Guide. If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role. For more information, see Protecting Data Using Server-Side Encryption. Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data. All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with KMS key (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an Amazon Web Services account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an Amazon Web Services account Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata: x-amz-grant-read: id="11112222333", id="444455556666" The following operations are related to CreateMultipartUpload: UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads */ createMultipartUpload(input: AWS.S3.CreateMultipartUploadRequest, options: SdkCallOptions): Promise; /** * Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. Related Resources CreateBucket DeleteObject */ deleteBucket(input: AWS.S3.DeleteBucketRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis. The following operations are related to DeleteBucketAnalyticsConfiguration: GetBucketAnalyticsConfiguration ListBucketAnalyticsConfigurations PutBucketAnalyticsConfiguration */ deleteBucketAnalyticsConfiguration(input: AWS.S3.DeleteBucketAnalyticsConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the cors configuration information set for the bucket. To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others. For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide. Related Resources: PutBucketCors RESTOPTIONSobject */ deleteBucketCors(input: AWS.S3.DeleteBucketCorsRequest, options: SdkCallOptions): Promise<{}>; /** * This implementation of the DELETE action removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide. To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide. Related Resources PutBucketEncryption GetBucketEncryption */ deleteBucketEncryption(input: AWS.S3.DeleteBucketEncryptionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the S3 Intelligent-Tiering configuration from the specified bucket. The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects. Operations related to DeleteBucketIntelligentTieringConfiguration include: GetBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration ListBucketIntelligentTieringConfigurations */ deleteBucketIntelligentTieringConfiguration(input: AWS.S3.DeleteBucketIntelligentTieringConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an inventory configuration (identified by the inventory ID) from the bucket. To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory. Operations related to DeleteBucketInventoryConfiguration include: GetBucketInventoryConfiguration PutBucketInventoryConfiguration ListBucketInventoryConfigurations */ deleteBucketInventoryConfiguration(input: AWS.S3.DeleteBucketInventoryConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others. There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. For more information about the object expiration, see Elements to Describe Lifecycle Actions. Related actions include: PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration */ deleteBucketLifecycle(input: AWS.S3.DeleteBucketLifecycleRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to DeleteBucketMetricsConfiguration: GetBucketMetricsConfiguration PutBucketMetricsConfiguration ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch */ deleteBucketMetricsConfiguration(input: AWS.S3.DeleteBucketMetricsConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. For information about Amazon S3 Object Ownership, see Using Object Ownership. The following operations are related to DeleteBucketOwnershipControls: GetBucketOwnershipControls PutBucketOwnershipControls */ deleteBucketOwnershipControls(input: AWS.S3.DeleteBucketOwnershipControlsRequest, options: SdkCallOptions): Promise<{}>; /** * This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation. If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and UserPolicies. The following operations are related to DeleteBucketPolicy CreateBucket DeleteObject */ deleteBucketPolicy(input: AWS.S3.DeleteBucketPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the replication configuration from the bucket. To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. It can take a while for the deletion of a replication configuration to fully propagate. For information about replication configuration, see Replication in the Amazon S3 User Guide. The following operations are related to DeleteBucketReplication: PutBucketReplication GetBucketReplication */ deleteBucketReplication(input: AWS.S3.DeleteBucketReplicationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the tags from the bucket. To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. The following operations are related to DeleteBucketTagging: GetBucketTagging PutBucketTagging */ deleteBucketTagging(input: AWS.S3.DeleteBucketTaggingRequest, options: SdkCallOptions): Promise<{}>; /** * This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist. This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission. For more information about hosting websites, see Hosting Websites on Amazon S3. The following operations are related to DeleteBucketWebsite: GetBucketWebsite PutBucketWebsite */ deleteBucketWebsite(input: AWS.S3.DeleteBucketWebsiteRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still respond that the command was successful. To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true. If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS. For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request. You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions. The following action is related to DeleteObject: PutObject */ deleteObject(input: AWS.S3.DeleteObjectRequest, options: SdkCallOptions): Promise; /** * Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging. To use this operation, you must have permission to perform the s3:DeleteObjectTagging action. To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action. The following operations are related to DeleteBucketMetricsConfiguration: PutObjectTagging GetObjectTagging */ deleteObjectTagging(input: AWS.S3.DeleteObjectTaggingRequest, options: SdkCallOptions): Promise; /** * This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead. The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted. The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body. When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete. Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit. The following operations are related to DeleteObjects: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts AbortMultipartUpload */ deleteObjects(input: AWS.S3.DeleteObjectsRequest, options: SdkCallOptions): Promise; /** * Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The following operations are related to DeletePublicAccessBlock: Using Amazon S3 Block Public Access GetPublicAccessBlock PutPublicAccessBlock GetBucketPolicyStatus */ deletePublicAccessBlock(input: AWS.S3.DeletePublicAccessBlockRequest, options: SdkCallOptions): Promise<{}>; /** * This implementation of the GET action uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3. To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide. You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation. A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket. For more information about transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide. Related Resources PutBucketAccelerateConfiguration */ getBucketAccelerateConfiguration(input: AWS.S3.GetBucketAccelerateConfigurationRequest, options: SdkCallOptions): Promise; /** * This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide. Related Resources ListObjects */ getBucketAcl(input: AWS.S3.GetBucketAclRequest, options: SdkCallOptions): Promise; /** * This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket. To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide. Related Resources DeleteBucketAnalyticsConfiguration ListBucketAnalyticsConfigurations PutBucketAnalyticsConfiguration */ getBucketAnalyticsConfiguration(input: AWS.S3.GetBucketAnalyticsConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket. To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others. For more information about CORS, see Enabling Cross-Origin Resource Sharing. The following operations are related to GetBucketCors: PutBucketCors DeleteBucketCors */ getBucketCors(input: AWS.S3.GetBucketCorsRequest, options: SdkCallOptions): Promise; /** * Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption. To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The following operations are related to GetBucketEncryption: PutBucketEncryption DeleteBucketEncryption */ getBucketEncryption(input: AWS.S3.GetBucketEncryptionRequest, options: SdkCallOptions): Promise; /** * Gets the S3 Intelligent-Tiering configuration from the specified bucket. The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects. Operations related to GetBucketIntelligentTieringConfiguration include: DeleteBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration ListBucketIntelligentTieringConfigurations */ getBucketIntelligentTieringConfiguration(input: AWS.S3.GetBucketIntelligentTieringConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns an inventory configuration (identified by the inventory configuration ID) from the bucket. To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory. The following operations are related to GetBucketInventoryConfiguration: DeleteBucketInventoryConfiguration ListBucketInventoryConfigurations PutBucketInventoryConfiguration */ getBucketInventoryConfiguration(input: AWS.S3.GetBucketInventoryConfigurationRequest, options: SdkCallOptions): Promise; /** * For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility. Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management. To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. GetBucketLifecycle has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following operations are related to GetBucketLifecycle: GetBucketLifecycleConfiguration PutBucketLifecycle DeleteBucketLifecycle */ getBucketLifecycle(input: AWS.S3.GetBucketLifecycleRequest, options: SdkCallOptions): Promise; /** * Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see GetBucketLifecycle. Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management. To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. GetBucketLifecycleConfiguration has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following operations are related to GetBucketLifecycleConfiguration: GetBucketLifecycle PutBucketLifecycle DeleteBucketLifecycle */ getBucketLifecycleConfiguration(input: AWS.S3.GetBucketLifecycleConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket. To use this implementation of the operation, you must be the bucket owner. To use this API against an access point, provide the alias of the access point in place of the bucket name. The following operations are related to GetBucketLocation: GetObject CreateBucket */ getBucketLocation(input: AWS.S3.GetBucketLocationRequest, options: SdkCallOptions): Promise; /** * Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. The following operations are related to GetBucketLogging: CreateBucket PutBucketLogging */ getBucketLogging(input: AWS.S3.GetBucketLoggingRequest, options: SdkCallOptions): Promise; /** * Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to GetBucketMetricsConfiguration: PutBucketMetricsConfiguration DeleteBucketMetricsConfiguration ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch */ getBucketMetricsConfiguration(input: AWS.S3.GetBucketMetricsConfigurationRequest, options: SdkCallOptions): Promise; /** * No longer used, see GetBucketNotificationConfiguration. */ getBucketNotification(input: AWS.S3.GetBucketNotificationConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns the notification configuration of a bucket. If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element. By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission. For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies. The following action is related to GetBucketNotification: PutBucketNotification */ getBucketNotificationConfiguration(input: AWS.S3.GetBucketNotificationConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy. For information about Amazon S3 Object Ownership, see Using Object Ownership. The following operations are related to GetBucketOwnershipControls: PutBucketOwnershipControls DeleteBucketOwnershipControls */ getBucketOwnershipControls(input: AWS.S3.GetBucketOwnershipControlsRequest, options: SdkCallOptions): Promise; /** * Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies. The following action is related to GetBucketPolicy: GetObject */ getBucketPolicy(input: AWS.S3.GetBucketPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public". The following operations are related to GetBucketPolicyStatus: Using Amazon S3 Block Public Access GetPublicAccessBlock PutPublicAccessBlock DeletePublicAccessBlock */ getBucketPolicyStatus(input: AWS.S3.GetBucketPolicyStatusRequest, options: SdkCallOptions): Promise; /** * Returns the replication configuration of a bucket. It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. For information about replication configuration, see Replication in the Amazon S3 User Guide. This action requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies. If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements. For information about GetBucketReplication errors, see List of replication-related error codes The following operations are related to GetBucketReplication: PutBucketReplication DeleteBucketReplication */ getBucketReplication(input: AWS.S3.GetBucketReplicationRequest, options: SdkCallOptions): Promise; /** * Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets. The following operations are related to GetBucketRequestPayment: ListObjects */ getBucketRequestPayment(input: AWS.S3.GetBucketRequestPaymentRequest, options: SdkCallOptions): Promise; /** * Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code: NoSuchTagSet Description: There is no tag set associated with the bucket. The following operations are related to GetBucketTagging: PutBucketTagging DeleteBucketTagging */ getBucketTagging(input: AWS.S3.GetBucketTaggingRequest, options: SdkCallOptions): Promise; /** * Returns the versioning state of a bucket. To retrieve the versioning state of a bucket, you must be the bucket owner. This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket. The following operations are related to GetBucketVersioning: GetObject PutObject DeleteObject */ getBucketVersioning(input: AWS.S3.GetBucketVersioningRequest, options: SdkCallOptions): Promise; /** * Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3. This GET action requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission. The following operations are related to DeleteBucketWebsite: DeleteBucketWebsite PutBucketWebsite */ getBucketWebsite(input: AWS.S3.GetBucketWebsiteRequest, options: SdkCallOptions): Promise; /** * Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error. Versioning By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource. If you supply a versionId, you need the s3:GetObjectVersion permission to access a specific version of an object. If you request a specific version, you do not need to have the s3:GetObject permission. If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response. For more information about versioning, see PutBucketVersioning. Overriding Response Header Values There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request. You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request. response-content-type response-content-language response-expires response-cache-control response-content-disposition response-content-encoding Additional Considerations about Request Headers If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code. For more information about conditional requests, see RFC 7232. The following operations are related to GetObject: ListBuckets GetObjectAcl */ getObject(input: AWS.S3.GetObjectRequest, options: SdkCallOptions): Promise; /** * Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide This action is not supported by Amazon S3 on Outposts. Versioning By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide. The following operations are related to GetObjectAcl: GetObject GetObjectAttributes DeleteObject PutObject */ getObjectAcl(input: AWS.S3.GetObjectAclRequest, options: SdkCallOptions): Promise; /** * Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to the object. GetObjectAttributes combines the functionality of GetObjectAcl, GetObjectLegalHold, GetObjectLockConfiguration, GetObjectRetention, GetObjectTagging, HeadObject, and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide. Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you'll get an HTTP 400 Bad Request error. The last modified property in this case is the creation date of the object. Consider the following when using request headers: If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested: If-Match condition evaluates to true. If-Unmodified-Since condition evaluates to false. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified: If-None-Match condition evaluates to false. If-Modified-Since condition evaluates to true. For more information about conditional requests, see RFC 7232. Permissions The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found ("no such key") error. If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error. The following actions are related to GetObjectAttributes: GetObject GetObjectAcl GetObjectLegalHold GetObjectLockConfiguration GetObjectRetention GetObjectTagging HeadObject ListParts */ getObjectAttributes(input: AWS.S3.GetObjectAttributesRequest, options: SdkCallOptions): Promise; /** * Gets an object's current legal hold status. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts. The following action is related to GetObjectLegalHold: GetObjectAttributes */ getObjectLegalHold(input: AWS.S3.GetObjectLegalHoldRequest, options: SdkCallOptions): Promise; /** * Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects. The following action is related to GetObjectLockConfiguration: GetObjectAttributes */ getObjectLockConfiguration(input: AWS.S3.GetObjectLockConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves an object's retention settings. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts. The following action is related to GetObjectRetention: GetObjectAttributes */ getObjectRetention(input: AWS.S3.GetObjectRetentionRequest, options: SdkCallOptions): Promise; /** * Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action. By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging. The following actions are related to GetObjectTagging: DeleteObjectTagging GetObjectAttributes PutObjectTagging */ getObjectTagging(input: AWS.S3.GetObjectTaggingRequest, options: SdkCallOptions): Promise; /** * Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3. You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key. To use GET, you must have READ access to the object. This action is not supported by Amazon S3 on Outposts. The following action is related to GetObjectTorrent: GetObject */ getObjectTorrent(input: AWS.S3.GetObjectTorrentRequest, options: SdkCallOptions): Promise; /** * Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public". The following operations are related to GetPublicAccessBlock: Using Amazon S3 Block Public Access PutPublicAccessBlock GetPublicAccessBlock DeletePublicAccessBlock */ getPublicAccessBlock(input: AWS.S3.GetPublicAccessBlockRequest, options: SdkCallOptions): Promise; /** * This action is useful to determine if a bucket exists and you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it. If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 404 Not Found or 403 Forbidden code. A message body is not included, so you cannot determine the exception beyond these error codes. To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points. */ headBucket(input: AWS.S3.HeadBucketRequest, options: SdkCallOptions): Promise<{}>; /** * The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following actions are related to HeadObject: GetObject GetObjectAttributes */ headObject(input: AWS.S3.HeadObjectRequest, options: SdkCallOptions): Promise; /** * Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis. The following operations are related to ListBucketAnalyticsConfigurations: GetBucketAnalyticsConfiguration DeleteBucketAnalyticsConfiguration PutBucketAnalyticsConfiguration */ listBucketAnalyticsConfigurations(input: AWS.S3.ListBucketAnalyticsConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists the S3 Intelligent-Tiering configuration from the specified bucket. The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects. Operations related to ListBucketIntelligentTieringConfigurations include: DeleteBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration GetBucketIntelligentTieringConfiguration */ listBucketIntelligentTieringConfigurations(input: AWS.S3.ListBucketIntelligentTieringConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory The following operations are related to ListBucketInventoryConfigurations: GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration PutBucketInventoryConfiguration */ listBucketInventoryConfigurations(input: AWS.S3.ListBucketInventoryConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket. This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to ListBucketMetricsConfigurations: PutBucketMetricsConfiguration GetBucketMetricsConfiguration DeleteBucketMetricsConfiguration */ listBucketMetricsConfigurations(input: AWS.S3.ListBucketMetricsConfigurationsRequest, options: SdkCallOptions): Promise; /** * This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted. This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters. In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions. The following operations are related to ListMultipartUploads: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts AbortMultipartUpload */ listMultipartUploads(input: AWS.S3.ListMultipartUploadsRequest, options: SdkCallOptions): Promise; /** * Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. To use this operation, you must have permissions to perform the s3:ListBucketVersions action. Be aware of the name difference. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. To use this operation, you must have READ access to the bucket. This action is not supported by Amazon S3 on Outposts. The following operations are related to ListObjectVersions: ListObjectsV2 GetObject PutObject DeleteObject */ listObjectVersions(input: AWS.S3.ListObjectVersionsRequest, options: SdkCallOptions): Promise; /** * Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately. This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects. The following operations are related to ListObjects: ListObjectsV2 GetObject PutObject CreateBucket ListBuckets */ listObjects(input: AWS.S3.ListObjectsRequest, options: SdkCallOptions): Promise; /** * Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically To use this operation, you must have READ access to the bucket. To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. This section describes the latest revision of this action. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects. To get a list of your buckets, see ListBuckets. The following operations are related to ListObjectsV2: GetObject PutObject CreateBucket */ listObjectsV2(input: AWS.S3.ListObjectsV2Request, options: SdkCallOptions): Promise; /** * Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response. If the upload was created using a checksum algorithm, you will need to have permission to the kms:Decrypt action for the request to succeed. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions. The following operations are related to ListParts: CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload GetObjectAttributes ListMultipartUploads */ listParts(input: AWS.S3.ListPartsRequest, options: SdkCallOptions): Promise; /** * Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3. To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The Transfer Acceleration state of a bucket can be set to one of the following two values: Enabled – Enables accelerated data transfers to the bucket. Suspended – Disables accelerated data transfers to the bucket. The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket. After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase. The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods ("."). For more information about transfer acceleration, see Transfer Acceleration. The following operations are related to PutBucketAccelerateConfiguration: GetBucketAccelerateConfiguration CreateBucket */ putBucketAccelerateConfiguration(input: AWS.S3.PutBucketAccelerateConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission. You can use one of the following two ways to set a bucket's permissions: Specify the ACL in the request body Specify permissions using request headers You cannot specify access permission using both the body and the request headers. Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide. Access Permissions You can set access permissions using one of the following methods: Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an Amazon Web Services account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an Amazon Web Services account Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses. x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By the person's ID: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee> DisplayName is optional and ignored in the request By URI: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> By Email address: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee> The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. Related Resources CreateBucket DeleteBucket GetObjectAcl */ putBucketAcl(input: AWS.S3.PutBucketAclRequest, options: SdkCallOptions): Promise<{}>; /** * Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket. You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis. You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis. To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. Special Errors HTTP Error: HTTP 400 Bad Request Code: InvalidArgument Cause: Invalid argument. HTTP Error: HTTP 400 Bad Request Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP Error: HTTP 403 Forbidden Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket. Related Resources GetBucketAnalyticsConfiguration DeleteBucketAnalyticsConfiguration ListBucketAnalyticsConfigurations */ putBucketAnalyticsConfiguration(input: AWS.S3.PutBucketAnalyticsConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it. To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others. You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability. To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met: The request's Origin header must match AllowedOrigin elements. The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements. Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element. For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide. Related Resources GetBucketCors DeleteBucketCors RESTOPTIONSobject */ putBucketCors(input: AWS.S3.PutBucketCorsRequest, options: SdkCallOptions): Promise<{}>; /** * This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket. Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for your account. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4). To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Related Resources GetBucketEncryption DeleteBucketEncryption */ putBucketEncryption(input: AWS.S3.PutBucketEncryptionRequest, options: SdkCallOptions): Promise<{}>; /** * Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket. The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects. Operations related to PutBucketIntelligentTieringConfiguration include: DeleteBucketIntelligentTieringConfiguration GetBucketIntelligentTieringConfiguration ListBucketIntelligentTieringConfigurations You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier. Special Errors HTTP 400 Bad Request Error Code: InvalidArgument Cause: Invalid Argument HTTP 400 Bad Request Error Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP 403 Forbidden Error Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket. */ putBucketIntelligentTieringConfiguration(input: AWS.S3.PutBucketIntelligentTieringConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket. When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide. You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis. To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Special Errors HTTP 400 Bad Request Error Code: InvalidArgument Cause: Invalid Argument HTTP 400 Bad Request Error Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP 403 Forbidden Error Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket. Related Resources GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration ListBucketInventoryConfigurations */ putBucketInventoryConfiguration(input: AWS.S3.PutBucketInventoryConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide. By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide. For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration. Related Resources GetBucketLifecycle(Deprecated) GetBucketLifecycleConfiguration RestoreObject By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide: Specifying Permissions in a Policy Managing Access Permissions to your Amazon S3 Resources */ putBucketLifecycle(input: AWS.S3.PutBucketLifecycleRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle. Rules You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following: Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both. Status whether the rule is in effect. One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. For more information, see Object Lifecycle Management and Lifecycle Configuration Elements. Permissions By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources. The following are related to PutBucketLifecycleConfiguration: Examples of Lifecycle Configuration GetBucketLifecycleConfiguration DeleteBucketLifecycle */ putBucketLifecycleConfiguration(input: AWS.S3.PutBucketLifecycleConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner. The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs. If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't use the Grantee request element to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By the person's ID: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee> DisplayName is optional and ignored in the request. By Email address: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. By URI: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element: <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /> For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide. For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging. The following operations are related to PutBucketLogging: PutObject DeleteBucket CreateBucket GetBucketLogging */ putBucketLogging(input: AWS.S3.PutBucketLoggingRequest, options: SdkCallOptions): Promise<{}>; /** * Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to PutBucketMetricsConfiguration: DeleteBucketMetricsConfiguration GetBucketMetricsConfiguration ListBucketMetricsConfigurations GetBucketLifecycle has the following special error: Error code: TooManyConfigurations Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP Status Code: HTTP 400 Bad Request */ putBucketMetricsConfiguration(input: AWS.S3.PutBucketMetricsConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * No longer used, see the PutBucketNotificationConfiguration operation. */ putBucketNotification(input: AWS.S3.PutBucketNotificationRequest, options: SdkCallOptions): Promise<{}>; /** * Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration. <NotificationConfiguration> </NotificationConfiguration> This action replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the empty NotificationConfiguration element. For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission. The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket. Responses If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic. The following action is related to PutBucketNotificationConfiguration: GetBucketNotificationConfiguration */ putBucketNotificationConfiguration(input: AWS.S3.PutBucketNotificationConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy. For information about Amazon S3 Object Ownership, see Using object ownership. The following operations are related to PutBucketOwnershipControls: GetBucketOwnershipControls DeleteBucketOwnershipControls */ putBucketOwnershipControls(input: AWS.S3.PutBucketOwnershipControlsRequest, options: SdkCallOptions): Promise<{}>; /** * Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information, see Bucket policy examples. The following operations are related to PutBucketPolicy: CreateBucket DeleteBucket */ putBucketPolicy(input: AWS.S3.PutBucketPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide. Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority. If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility. For information about enabling versioning on a bucket, see Using Versioning. Handling Replication of Encrypted Objects By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys. For information on PutBucketReplication errors, see List of replication-related error codes Permissions To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket. By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources. To perform this operation, the user or role performing the action must have the iam:PassRole permission. The following operations are related to PutBucketReplication: GetBucketReplication DeleteBucketReplication */ putBucketReplication(input: AWS.S3.PutBucketReplicationRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets. The following operations are related to PutBucketRequestPayment: CreateBucket GetBucketRequestPayment */ putBucketRequestPayment(input: AWS.S3.PutBucketRequestPaymentRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the tags for a bucket. Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging and Using Cost Allocation in Amazon S3 Bucket Tags. When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags. To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. PutBucketTagging has the following special errors: Error code: InvalidTagError Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions. Error code: MalformedXMLError Description: The XML provided does not match the schema. Error code: OperationAbortedError Description: A conflicting conditional action is currently in progress against this resource. Please try again. Error code: InternalError Description: The service was unable to apply the provided tag to the bucket. The following operations are related to PutBucketTagging: GetBucketTagging DeleteBucketTagging */ putBucketTagging(input: AWS.S3.PutBucketTaggingRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the versioning state of an existing bucket. You can set the versioning state with one of the following values: Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value. In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket. If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning. Related Resources CreateBucket DeleteBucket GetBucketVersioning */ putBucketVersioning(input: AWS.S3.PutBucketVersioningRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3. This PUT action requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission. To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket. WebsiteConfiguration RedirectAllRequestsTo HostName Protocol If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. WebsiteConfiguration IndexDocument Suffix ErrorDocument Key RoutingRules RoutingRule Condition HttpErrorCodeReturnedEquals KeyPrefixEquals Redirect Protocol HostName ReplaceKeyPrefixWith ReplaceKeyWith HttpRedirectCode Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide. */ putBucketWebsite(input: AWS.S3.PutBucketWebsiteRequest, options: SdkCallOptions): Promise<{}>; /** * Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it. Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead. To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value. To successfully complete the PutObject request, you must have the s3:PutObject in your IAM permissions. To successfully change the objects acl of your PutObject request, you must have the s3:PutObjectAcl in your IAM permissions. The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide. Server-side Encryption You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side Encryption. If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. Access Control List (ACL)-Specific Request Headers You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API. If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner. Storage Class Options By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide. Versioning If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning. Related Resources CopyObject DeleteObject */ putObject(input: AWS.S3.PutObjectRequest, options: SdkCallOptions): Promise; /** * Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have WRITE_ACP permission to set the ACL of an object. For more information, see What permissions can I grant? in the Amazon S3 User Guide. This action is not supported by Amazon S3 on Outposts. Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide. Access Permissions You can set access permissions using one of the following methods: Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You specify each grantee as a type=value pair, where the type is one of the following: id – if the value specified is the canonical user ID of an Amazon Web Services account uri – if you are granting permissions to a predefined group emailAddress – if the value specified is the email address of an Amazon Web Services account Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For example, the following x-amz-grant-read header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses. x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By the person's ID: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee> DisplayName is optional and ignored in the request. By URI: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> By Email address: <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee> The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. Versioning The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource. Related Resources CopyObject GetObject */ putObjectAcl(input: AWS.S3.PutObjectAclRequest, options: SdkCallOptions): Promise; /** * Applies a legal hold configuration to the specified object. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts. */ putObjectLegalHold(input: AWS.S3.PutObjectLegalHoldRequest, options: SdkCallOptions): Promise; /** * Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects. The DefaultRetention settings require both a mode and a period. The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time. You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact Amazon Web Services Support. */ putObjectLockConfiguration(input: AWS.S3.PutObjectLockConfigurationRequest, options: SdkCallOptions): Promise; /** * Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission. This action is not supported by Amazon S3 on Outposts. */ putObjectRetention(input: AWS.S3.PutObjectRetentionRequest, options: SdkCallOptions): Promise; /** * Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging. For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object. To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others. To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action. For information about the Amazon S3 object tagging feature, see Object Tagging. Special Errors Code: InvalidTagError Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging. Code: MalformedXMLError Cause: The XML provided does not match the schema. Code: OperationAbortedError Cause: A conflicting conditional action is currently in progress against this resource. Please try again. Code: InternalError Cause: The service was unable to apply the provided tag to the object. Related Resources GetObjectTagging DeleteObjectTagging */ putObjectTagging(input: AWS.S3.PutObjectTaggingRequest, options: SdkCallOptions): Promise; /** * Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public". Related Resources GetPublicAccessBlock DeletePublicAccessBlock GetBucketPolicyStatus Using Amazon S3 Block Public Access */ putPublicAccessBlock(input: AWS.S3.PutPublicAccessBlockRequest, options: SdkCallOptions): Promise<{}>; /** * Restores an archived copy of an object back into Amazon S3 This action is not supported by Amazon S3 on Outposts. This action performs the following types of requests: select - Perform a select query on an archived object restore an archive - Restore an archived object To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. Querying Archives with Select Requests You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide. When making a select request, do the following: Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon S3 User Guide. For more information about the S3 structure in the request body, see the following: PutObject Managing Access with ACLs in the Amazon S3 User Guide Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples. The following expression returns all records from the specified object. SELECT * FROM Object Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE s._3 > 100 If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. SELECT s.Id, s.FirstName, s.SSN FROM S3Object s For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide. When making a select request, you can also do the following: To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic. Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results. The following are additional important facts about the select feature: The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy. You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests. Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409. Restoring objects Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify. To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version. When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body: Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering. Bulk - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering. For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide. You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide. To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide. After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object. If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide. Responses A successful action returns either the 200 OK or 202 Accepted status code. If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response. If the object is previously restored, Amazon S3 returns 200 OK in the response. Special Errors Code: RestoreAlreadyInProgress Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.) HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: GlacierExpeditedRetrievalNotAvailable Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.) HTTP Status Code: 503 SOAP Fault Code Prefix: N/A Related Resources PutBucketLifecycleConfiguration GetBucketNotificationConfiguration SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide */ restoreObject(input: AWS.S3.RestoreObjectRequest, options: SdkCallOptions): Promise; /** * This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. This action is not supported by Amazon S3 on Outposts. For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide. For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon S3 User Guide. Permissions You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide. Object Data Formats You can use Amazon S3 Select to query objects that have the following format properties: CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format. UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports. GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects. Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption. For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide. For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide. Working with the Response Body Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response. GetObject Support The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject. Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return. GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage Classes in the Amazon S3 User Guide. Special Errors For a list of special errors for this operation, see List of SELECT Object Content Error Codes Related Resources GetObject GetBucketLifecycleConfiguration PutBucketLifecycleConfiguration */ selectObjectContent(input: AWS.S3.SelectObjectContentRequest, options: SdkCallOptions): Promise; /** * Uploads a part in a multipart upload. In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation. You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide. To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4). Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide . For information on the permissions required to use the multipart upload API, go to Multipart Upload and Permissions in the Amazon S3 User Guide. You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon S3 User Guide. Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload. If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers. x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Related Resources CreateMultipartUpload CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads */ uploadPart(input: AWS.S3.UploadPartRequest, options: SdkCallOptions): Promise; /** * Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request. For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide. Instead of using an existing object as part data, you might use the UploadPart action and provide data in your request. You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request. For more information about using the UploadPartCopy operation, see the following: For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide. For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart. Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since: Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows: x-amz-copy-source-if-match condition evaluates to true, and; x-amz-copy-source-if-unmodified-since condition evaluates to false; Amazon S3 returns 200 OK and copies the data. Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows: x-amz-copy-source-if-none-match condition evaluates to false, and; x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 returns 412 Precondition Failed response code. Versioning If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source. You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example: x-amz-copy-source: /bucket/object?versionId=version id Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found Code: InvalidRequest Cause: The specified copy source is not supported as a byte-range copy source. HTTP Status Code: 400 Bad Request Related Resources CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads */ uploadPartCopy(input: AWS.S3.UploadPartCopyRequest, options: SdkCallOptions): Promise; /** * Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide. This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return. You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata. Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point. Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket. Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket. Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP. For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide. */ writeGetObjectResponse(input: AWS.S3.WriteGetObjectResponseRequest, options: SdkCallOptions): Promise<{}>; } export interface S3Control { /** * Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide. S3 on Outposts only supports VPC-style access points. For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to CreateAccessPoint: GetAccessPoint DeleteAccessPoint ListAccessPoints */ createAccessPoint(input: AWS.S3Control.CreateAccessPointRequest, options: SdkCallOptions): Promise; /** * Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide. The following actions are related to CreateAccessPointForObjectLambda: DeleteAccessPointForObjectLambda GetAccessPointForObjectLambda ListAccessPointsForObjectLambda */ createAccessPointForObjectLambda(input: AWS.S3Control.CreateAccessPointForObjectLambdaRequest, options: SdkCallOptions): Promise; /** * This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference. Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets. S3 on Outposts buckets support: Tags LifecycleConfigurations for deleting expired objects For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section. The following actions are related to CreateBucket for Amazon S3 on Outposts: PutObject GetBucket DeleteBucket CreateAccessPoint PutAccessPointPolicy */ createBucket(input: AWS.S3Control.CreateBucketRequest, options: SdkCallOptions): Promise; /** * You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide. This action creates a S3 Batch Operations job. Related actions include: DescribeJob ListJobs UpdateJobPriority UpdateJobStatus JobOperation */ createJob(input: AWS.S3Control.CreateJobRequest, options: SdkCallOptions): Promise; /** * Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide. This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation. The following actions are related to CreateMultiRegionAccessPoint: DeleteMultiRegionAccessPoint DescribeMultiRegionAccessPointOperation GetMultiRegionAccessPoint ListMultiRegionAccessPoints */ createMultiRegionAccessPoint(input: AWS.S3Control.CreateMultiRegionAccessPointRequest, options: SdkCallOptions): Promise; /** * Deletes the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to DeleteAccessPoint: CreateAccessPoint GetAccessPoint ListAccessPoints */ deleteAccessPoint(input: AWS.S3Control.DeleteAccessPointRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified Object Lambda Access Point. The following actions are related to DeleteAccessPointForObjectLambda: CreateAccessPointForObjectLambda GetAccessPointForObjectLambda ListAccessPointsForObjectLambda */ deleteAccessPointForObjectLambda(input: AWS.S3Control.DeleteAccessPointForObjectLambdaRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the access point policy for the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to DeleteAccessPointPolicy: PutAccessPointPolicy GetAccessPointPolicy */ deleteAccessPointPolicy(input: AWS.S3Control.DeleteAccessPointPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the resource policy for an Object Lambda Access Point. The following actions are related to DeleteAccessPointPolicyForObjectLambda: GetAccessPointPolicyForObjectLambda PutAccessPointPolicyForObjectLambda */ deleteAccessPointPolicyForObjectLambda(input: AWS.S3Control.DeleteAccessPointPolicyForObjectLambdaRequest, options: SdkCallOptions): Promise<{}>; /** * This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference. Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. Related Resources CreateBucket GetBucket DeleteObject */ deleteBucket(input: AWS.S3Control.DeleteBucketRequest, options: SdkCallOptions): Promise<{}>; /** * This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference. Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. For more information about object expiration, see Elements to Describe Lifecycle Actions. Related actions include: PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration */ deleteBucketLifecycleConfiguration(input: AWS.S3Control.DeleteBucketLifecycleConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference. This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to DeleteBucketPolicy: GetBucketPolicy PutBucketPolicy */ deleteBucketPolicy(input: AWS.S3Control.DeleteBucketPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference. Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to DeleteBucketTagging: GetBucketTagging PutBucketTagging */ deleteBucketTagging(input: AWS.S3Control.DeleteBucketTaggingRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide. Related actions include: CreateJob GetJobTagging PutJobTagging */ deleteJobTagging(input: AWS.S3Control.DeleteJobTaggingRequest, options: SdkCallOptions): Promise; /** * Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide. This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation. The following actions are related to DeleteMultiRegionAccessPoint: CreateMultiRegionAccessPoint DescribeMultiRegionAccessPointOperation GetMultiRegionAccessPoint ListMultiRegionAccessPoints */ deleteMultiRegionAccessPoint(input: AWS.S3Control.DeleteMultiRegionAccessPointRequest, options: SdkCallOptions): Promise; /** * Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access. Related actions include: GetPublicAccessBlock PutPublicAccessBlock */ deletePublicAccessBlock(input: AWS.S3Control.DeletePublicAccessBlockRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide. */ deleteStorageLensConfiguration(input: AWS.S3Control.DeleteStorageLensConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide. */ deleteStorageLensConfigurationTagging(input: AWS.S3Control.DeleteStorageLensConfigurationTaggingRequest, options: SdkCallOptions): Promise; /** * Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide. Related actions include: CreateJob ListJobs UpdateJobPriority UpdateJobStatus */ describeJob(input: AWS.S3Control.DescribeJobRequest, options: SdkCallOptions): Promise; /** * Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPoint: CreateMultiRegionAccessPoint DeleteMultiRegionAccessPoint GetMultiRegionAccessPoint ListMultiRegionAccessPoints */ describeMultiRegionAccessPointOperation(input: AWS.S3Control.DescribeMultiRegionAccessPointOperationRequest, options: SdkCallOptions): Promise; /** * Returns configuration information about the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to GetAccessPoint: CreateAccessPoint DeleteAccessPoint ListAccessPoints */ getAccessPoint(input: AWS.S3Control.GetAccessPointRequest, options: SdkCallOptions): Promise; /** * Returns configuration for an Object Lambda Access Point. The following actions are related to GetAccessPointConfigurationForObjectLambda: PutAccessPointConfigurationForObjectLambda */ getAccessPointConfigurationForObjectLambda(input: AWS.S3Control.GetAccessPointConfigurationForObjectLambdaRequest, options: SdkCallOptions): Promise; /** * Returns configuration information about the specified Object Lambda Access Point The following actions are related to GetAccessPointForObjectLambda: CreateAccessPointForObjectLambda DeleteAccessPointForObjectLambda ListAccessPointsForObjectLambda */ getAccessPointForObjectLambda(input: AWS.S3Control.GetAccessPointForObjectLambdaRequest, options: SdkCallOptions): Promise; /** * Returns the access point policy associated with the specified access point. The following actions are related to GetAccessPointPolicy: PutAccessPointPolicy DeleteAccessPointPolicy */ getAccessPointPolicy(input: AWS.S3Control.GetAccessPointPolicyRequest, options: SdkCallOptions): Promise; /** * Returns the resource policy for an Object Lambda Access Point. The following actions are related to GetAccessPointPolicyForObjectLambda: DeleteAccessPointPolicyForObjectLambda PutAccessPointPolicyForObjectLambda */ getAccessPointPolicyForObjectLambda(input: AWS.S3Control.GetAccessPointPolicyForObjectLambdaRequest, options: SdkCallOptions): Promise; /** * Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 access points in the Amazon S3 User Guide. */ getAccessPointPolicyStatus(input: AWS.S3Control.GetAccessPointPolicyStatusRequest, options: SdkCallOptions): Promise; /** * Returns the status of the resource policy associated with an Object Lambda Access Point. */ getAccessPointPolicyStatusForObjectLambda(input: AWS.S3Control.GetAccessPointPolicyStatusForObjectLambdaRequest, options: SdkCallOptions): Promise; /** * Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error. The following actions are related to GetBucket for Amazon S3 on Outposts: All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. PutObject CreateBucket DeleteBucket */ getBucket(input: AWS.S3Control.GetBucketRequest, options: SdkCallOptions): Promise; /** * This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference. Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide. To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. GetBucketLifecycleConfiguration has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following actions are related to GetBucketLifecycleConfiguration: PutBucketLifecycleConfiguration DeleteBucketLifecycleConfiguration */ getBucketLifecycleConfiguration(input: AWS.S3Control.GetBucketLifecycleConfigurationRequest, options: SdkCallOptions): Promise; /** * This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference. Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error. As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to GetBucketPolicy: GetObject PutBucketPolicy DeleteBucketPolicy */ getBucketPolicy(input: AWS.S3Control.GetBucketPolicyRequest, options: SdkCallOptions): Promise; /** * This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference. Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. To use this action, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code: NoSuchTagSetError Description: There is no tag set associated with the bucket. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to GetBucketTagging: PutBucketTagging DeleteBucketTagging */ getBucketTagging(input: AWS.S3Control.GetBucketTaggingRequest, options: SdkCallOptions): Promise; /** * This operation returns the versioning state only for S3 on Outposts buckets. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference. Returns the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple distinct copies of your data and recover from unintended user actions and application failures. If you've never set versioning on your bucket, it has no versioning state. In that case, the GetBucketVersioning request does not return a versioning state value. For more information about versioning, see Versioning in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following operations are related to GetBucketVersioning for S3 on Outposts. PutBucketVersioning PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration */ getBucketVersioning(input: AWS.S3Control.GetBucketVersioningRequest, options: SdkCallOptions): Promise; /** * Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide. Related actions include: CreateJob PutJobTagging DeleteJobTagging */ getJobTagging(input: AWS.S3Control.GetJobTaggingRequest, options: SdkCallOptions): Promise; /** * Returns configuration information about the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPoint: CreateMultiRegionAccessPoint DeleteMultiRegionAccessPoint DescribeMultiRegionAccessPointOperation ListMultiRegionAccessPoints */ getMultiRegionAccessPoint(input: AWS.S3Control.GetMultiRegionAccessPointRequest, options: SdkCallOptions): Promise; /** * Returns the access control policy of the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicyStatus PutMultiRegionAccessPointPolicy */ getMultiRegionAccessPointPolicy(input: AWS.S3Control.GetMultiRegionAccessPointPolicyRequest, options: SdkCallOptions): Promise; /** * Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPointPolicyStatus: GetMultiRegionAccessPointPolicy PutMultiRegionAccessPointPolicy */ getMultiRegionAccessPointPolicyStatus(input: AWS.S3Control.GetMultiRegionAccessPointPolicyStatusRequest, options: SdkCallOptions): Promise; /** * Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access. Related actions include: DeletePublicAccessBlock PutPublicAccessBlock */ getPublicAccessBlock(input: AWS.S3Control.GetPublicAccessBlockRequest, options: SdkCallOptions): Promise; /** * Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide. */ getStorageLensConfiguration(input: AWS.S3Control.GetStorageLensConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide. */ getStorageLensConfigurationTagging(input: AWS.S3Control.GetStorageLensConfigurationTaggingRequest, options: SdkCallOptions): Promise; /** * Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to ListAccessPoints: CreateAccessPoint DeleteAccessPoint GetAccessPoint */ listAccessPoints(input: AWS.S3Control.ListAccessPointsRequest, options: SdkCallOptions): Promise; /** * Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points. The following actions are related to ListAccessPointsForObjectLambda: CreateAccessPointForObjectLambda DeleteAccessPointForObjectLambda GetAccessPointForObjectLambda */ listAccessPointsForObjectLambda(input: AWS.S3Control.ListAccessPointsForObjectLambdaRequest, options: SdkCallOptions): Promise; /** * Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide. Related actions include: CreateJob DescribeJob UpdateJobPriority UpdateJobStatus */ listJobs(input: AWS.S3Control.ListJobsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide. The following actions are related to ListMultiRegionAccessPoint: CreateMultiRegionAccessPoint DeleteMultiRegionAccessPoint DescribeMultiRegionAccessPointOperation GetMultiRegionAccessPoint */ listMultiRegionAccessPoints(input: AWS.S3Control.ListMultiRegionAccessPointsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section. */ listRegionalBuckets(input: AWS.S3Control.ListRegionalBucketsRequest, options: SdkCallOptions): Promise; /** * Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide. */ listStorageLensConfigurations(input: AWS.S3Control.ListStorageLensConfigurationsRequest, options: SdkCallOptions): Promise; /** * Replaces configuration for an Object Lambda Access Point. The following actions are related to PutAccessPointConfigurationForObjectLambda: GetAccessPointConfigurationForObjectLambda */ putAccessPointConfigurationForObjectLambda(input: AWS.S3Control.PutAccessPointConfigurationForObjectLambdaRequest, options: SdkCallOptions): Promise<{}>; /** * Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to PutAccessPointPolicy: GetAccessPointPolicy DeleteAccessPointPolicy */ putAccessPointPolicy(input: AWS.S3Control.PutAccessPointPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide. The following actions are related to PutAccessPointPolicyForObjectLambda: DeleteAccessPointPolicyForObjectLambda GetAccessPointPolicyForObjectLambda */ putAccessPointPolicyForObjectLambda(input: AWS.S3Control.PutAccessPointPolicyForObjectLambdaRequest, options: SdkCallOptions): Promise<{}>; /** * This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference. Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to PutBucketLifecycleConfiguration: GetBucketLifecycleConfiguration DeleteBucketLifecycleConfiguration */ putBucketLifecycleConfiguration(input: AWS.S3Control.PutBucketLifecycleConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference. Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action. If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to PutBucketPolicy: GetBucketPolicy DeleteBucketPolicy */ putBucketPolicy(input: AWS.S3Control.PutBucketPolicyRequest, options: SdkCallOptions): Promise<{}>; /** * This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference. Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging. Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags. To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources. PutBucketTagging has the following special errors: Error code: InvalidTagError Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions. Error code: MalformedXMLError Description: The XML provided does not match the schema. Error code: OperationAbortedError Description: A conflicting conditional action is currently in progress against this resource. Try again. Error code: InternalError Description: The service was unable to apply the provided tag to the bucket. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following actions are related to PutBucketTagging: GetBucketTagging DeleteBucketTagging */ putBucketTagging(input: AWS.S3Control.PutBucketTaggingRequest, options: SdkCallOptions): Promise<{}>; /** * This operation sets the versioning state only for S3 on Outposts buckets. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference. Sets the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple distinct copies of your data and recover from unintended user actions and application failures. You can set the versioning state to one of the following: Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value. When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide. If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The following operations are related to PutBucketVersioning for S3 on Outposts. GetBucketVersioning PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration */ putBucketVersioning(input: AWS.S3Control.PutBucketVersioningRequest, options: SdkCallOptions): Promise<{}>; /** * Sets the supplied tag-set on an S3 Batch Operations job. A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide. If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing. For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges. A few things to consider about using tags: Amazon S3 limits the maximum number of tags to 50 tags per job. You can associate up to 50 tags with a job as long as they have unique tag keys. A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length. The key and values are case sensitive. For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the Billing and Cost Management User Guide. To use this action, you must have permission to perform the s3:PutJobTagging action. Related actions include: CreateJob GetJobTagging DeleteJobTagging */ putJobTagging(input: AWS.S3Control.PutJobTaggingRequest, options: SdkCallOptions): Promise; /** * Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide. The following actions are related to PutMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicy GetMultiRegionAccessPointPolicyStatus */ putMultiRegionAccessPointPolicy(input: AWS.S3Control.PutMultiRegionAccessPointPolicyRequest, options: SdkCallOptions): Promise; /** * Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access. Related actions include: GetPublicAccessBlock DeletePublicAccessBlock */ putPublicAccessBlock(input: AWS.S3Control.PutPublicAccessBlockRequest, options: SdkCallOptions): Promise<{}>; /** * Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide. */ putStorageLensConfiguration(input: AWS.S3Control.PutStorageLensConfigurationRequest, options: SdkCallOptions): Promise<{}>; /** * Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide. */ putStorageLensConfigurationTagging(input: AWS.S3Control.PutStorageLensConfigurationTaggingRequest, options: SdkCallOptions): Promise; /** * Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus */ updateJobPriority(input: AWS.S3Control.UpdateJobPriorityRequest, options: SdkCallOptions): Promise; /** * Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus */ updateJobStatus(input: AWS.S3Control.UpdateJobStatusRequest, options: SdkCallOptions): Promise; } export interface S3Outposts { /** * Creates an endpoint and associates it with the specified Outpost. It can take up to 5 minutes for this action to finish. Related actions include: DeleteEndpoint ListEndpoints */ createEndpoint(input: AWS.S3Outposts.CreateEndpointRequest, options: SdkCallOptions): Promise; /** * Deletes an endpoint. It can take up to 5 minutes for this action to finish. Related actions include: CreateEndpoint ListEndpoints */ deleteEndpoint(input: AWS.S3Outposts.DeleteEndpointRequest, options: SdkCallOptions): Promise<{}>; /** * Lists endpoints associated with the specified Outpost. Related actions include: CreateEndpoint DeleteEndpoint */ listEndpoints(input: AWS.S3Outposts.ListEndpointsRequest, options: SdkCallOptions): Promise; /** * Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM). Related actions include: CreateEndpoint DeleteEndpoint */ listSharedEndpoints(input: AWS.S3Outposts.ListSharedEndpointsRequest, options: SdkCallOptions): Promise; } export interface SageMaker { /** * Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking. */ addAssociation(input: AWS.SageMaker.AddAssociationRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies. Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile. */ addTags(input: AWS.SageMaker.AddTagsInput, options: SdkCallOptions): Promise; /** * Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API. */ associateTrialComponent(input: AWS.SageMaker.AssociateTrialComponentRequest, options: SdkCallOptions): Promise; /** * This action batch describes a list of versioned model packages */ batchDescribeModelPackage(input: AWS.SageMaker.BatchDescribeModelPackageInput, options: SdkCallOptions): Promise; /** * Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking. */ createAction(input: AWS.SageMaker.CreateActionRequest, options: SdkCallOptions): Promise; /** * Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace. */ createAlgorithm(input: AWS.SageMaker.CreateAlgorithmInput, options: SdkCallOptions): Promise; /** * Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously. */ createApp(input: AWS.SageMaker.CreateAppRequest, options: SdkCallOptions): Promise; /** * Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image. */ createAppImageConfig(input: AWS.SageMaker.CreateAppImageConfigRequest, options: SdkCallOptions): Promise; /** * Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking. */ createArtifact(input: AWS.SageMaker.CreateArtifactRequest, options: SdkCallOptions): Promise; /** * Creates an Autopilot job. Find the best-performing model after you run an Autopilot job by calling . For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot. */ createAutoMLJob(input: AWS.SageMaker.CreateAutoMLJobRequest, options: SdkCallOptions): Promise; /** * Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository. */ createCodeRepository(input: AWS.SageMaker.CreateCodeRepositoryInput, options: SdkCallOptions): Promise; /** * Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource. In the request body, you provide the following: A name for the compilation job Information about the input model artifacts The output location for the compiled model and the device (target) that the model runs on The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job. You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job. To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs. */ createCompilationJob(input: AWS.SageMaker.CreateCompilationJobRequest, options: SdkCallOptions): Promise; /** * Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking. */ createContext(input: AWS.SageMaker.CreateContextRequest, options: SdkCallOptions): Promise; /** * Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor. */ createDataQualityJobDefinition(input: AWS.SageMaker.CreateDataQualityJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a device fleet. */ createDeviceFleet(input: AWS.SageMaker.CreateDeviceFleetRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other. EFS storage When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption. VPC configuration All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available: PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value. VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections. NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully. For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC. */ createDomain(input: AWS.SageMaker.CreateDomainRequest, options: SdkCallOptions): Promise; /** * Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices. */ createEdgeDeploymentPlan(input: AWS.SageMaker.CreateEdgeDeploymentPlanRequest, options: SdkCallOptions): Promise; /** * Creates a new stage in an existing edge deployment plan. */ createEdgeDeploymentStage(input: AWS.SageMaker.CreateEdgeDeploymentStageRequest, options: SdkCallOptions): Promise<{}>; /** * Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify. */ createEdgePackagingJob(input: AWS.SageMaker.CreateEdgePackagingJobRequest, options: SdkCallOptions): Promise<{}>; /** * Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API to deploy models using SageMaker hosting services. For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role. Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy. Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ "arn:aws:sagemaker:region:account-id:endpoint/endpointName" "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference. */ createEndpoint(input: AWS.SageMaker.CreateEndpointInput, options: SdkCallOptions): Promise; /** * Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API. Use this API if you want to use SageMaker hosting services to deploy models into production. In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy. If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. */ createEndpointConfig(input: AWS.SageMaker.CreateEndpointConfigInput, options: SdkCallOptions): Promise; /** * Creates an SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model. The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant. When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to experiments, trials, trial components and then use the Search API to search for the tags. To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API. To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API. */ createExperiment(input: AWS.SageMaker.CreateExperimentRequest, options: SdkCallOptions): Promise; /** * Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record. The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account. You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup. */ createFeatureGroup(input: AWS.SageMaker.CreateFeatureGroupRequest, options: SdkCallOptions): Promise; /** * Creates a flow definition. */ createFlowDefinition(input: AWS.SageMaker.CreateFlowDefinitionRequest, options: SdkCallOptions): Promise; /** * Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area. */ createHumanTaskUi(input: AWS.SageMaker.CreateHumanTaskUiRequest, options: SdkCallOptions): Promise; /** * Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose. */ createHyperParameterTuningJob(input: AWS.SageMaker.CreateHyperParameterTuningJobRequest, options: SdkCallOptions): Promise; /** * Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image. */ createImage(input: AWS.SageMaker.CreateImageRequest, options: SdkCallOptions): Promise; /** * Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage. */ createImageVersion(input: AWS.SageMaker.CreateImageVersionRequest, options: SdkCallOptions): Promise; /** * Starts a recommendation job. You can create either an instance recommendation or load test job. */ createInferenceRecommendationsJob(input: AWS.SageMaker.CreateInferenceRecommendationsJobRequest, options: SdkCallOptions): Promise; /** * Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models. You can select your workforce from one of three providers: A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required. One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas. The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information. You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling. The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data. The output can be used as the manifest file for another labeling job or as training data for your machine learning models. You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job. */ createLabelingJob(input: AWS.SageMaker.CreateLabelingJobRequest, options: SdkCallOptions): Promise; /** * Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job. To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment. For an example that calls this method when deploying a model to SageMaker hosting services, see Create a Model (Amazon Web Services SDK for Python (Boto 3)). To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role. */ createModel(input: AWS.SageMaker.CreateModelInput, options: SdkCallOptions): Promise; /** * Creates the definition for a model bias job. */ createModelBiasJobDefinition(input: AWS.SageMaker.CreateModelBiasJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates the definition for a model explainability job. */ createModelExplainabilityJobDefinition(input: AWS.SageMaker.CreateModelExplainabilityJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker. To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification. There are two types of model packages: Versioned - a model that is part of a model group in the model registry. Unversioned - a model package that is not part of a model group. */ createModelPackage(input: AWS.SageMaker.CreateModelPackageInput, options: SdkCallOptions): Promise; /** * Creates a model group. A model group contains a group of model versions. */ createModelPackageGroup(input: AWS.SageMaker.CreateModelPackageGroupInput, options: SdkCallOptions): Promise; /** * Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor. */ createModelQualityJobDefinition(input: AWS.SageMaker.CreateModelQualityJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint. */ createMonitoringSchedule(input: AWS.SageMaker.CreateMonitoringScheduleRequest, options: SdkCallOptions): Promise; /** * Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance. SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework. After receiving the request, SageMaker does the following: Creates a network interface in the SageMaker VPC. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it. After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it. After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models. For more information, see How It Works. */ createNotebookInstance(input: AWS.SageMaker.CreateNotebookInstanceInput, options: SdkCallOptions): Promise; /** * Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance. Each lifecycle configuration script has a limit of 16384 characters. The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin. View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook]. Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. */ createNotebookInstanceLifecycleConfig(input: AWS.SageMaker.CreateNotebookInstanceLifecycleConfigInput, options: SdkCallOptions): Promise; /** * Creates a pipeline using a JSON pipeline definition. */ createPipeline(input: AWS.SageMaker.CreatePipelineRequest, options: SdkCallOptions): Promise; /** * Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM. The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app. You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to SageMaker Studio Through an Interface VPC Endpoint . The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page. */ createPresignedDomainUrl(input: AWS.SageMaker.CreatePresignedDomainUrlRequest, options: SdkCallOptions): Promise; /** * Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page. The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance. You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address. The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page. */ createPresignedNotebookInstanceUrl(input: AWS.SageMaker.CreatePresignedNotebookInstanceUrlInput, options: SdkCallOptions): Promise; /** * Creates a processing job. */ createProcessingJob(input: AWS.SageMaker.CreateProcessingJobRequest, options: SdkCallOptions): Promise; /** * Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model. */ createProject(input: AWS.SageMaker.CreateProjectInput, options: SdkCallOptions): Promise; /** * Creates a new Studio Lifecycle Configuration. */ createStudioLifecycleConfig(input: AWS.SageMaker.CreateStudioLifecycleConfigRequest, options: SdkCallOptions): Promise; /** * Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms. You must not include any security-sensitive information, such as account access IDs, secrets, and tokens, in the dictionary for configuring hyperparameters. SageMaker rejects the training job request and returns an exception error for detected credentials, if such user input is found. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training. StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete. Environment - The environment variables to set in the Docker container. RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError. For more information about SageMaker, see How It Works. */ createTrainingJob(input: AWS.SageMaker.CreateTrainingJobRequest, options: SdkCallOptions): Promise; /** * Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify. To perform batch transformations, you create a transform job and use the data that you have readily available. In the request body, you provide the following: TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel. TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored. TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. TransformResources - Identifies the ML compute instances for the transform job. For more information about how batch transformation works, see Batch Transform. */ createTransformJob(input: AWS.SageMaker.CreateTransformJobRequest, options: SdkCallOptions): Promise; /** * Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment. When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial and then use the Search API to search for the tags. To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API. */ createTrial(input: AWS.SageMaker.CreateTrialRequest, options: SdkCallOptions): Promise; /** * Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs, training jobs, and batch transform jobs. When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial component and then use the Search API to search for the tags. */ createTrialComponent(input: AWS.SageMaker.CreateTrialComponentRequest, options: SdkCallOptions): Promise; /** * Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory. */ createUserProfile(input: AWS.SageMaker.CreateUserProfileRequest, options: SdkCallOptions): Promise; /** * Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account. If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce. To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito). To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP). */ createWorkforce(input: AWS.SageMaker.CreateWorkforceRequest, options: SdkCallOptions): Promise; /** * Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team. You cannot create more than 25 work teams in an account and region. */ createWorkteam(input: AWS.SageMaker.CreateWorkteamRequest, options: SdkCallOptions): Promise; /** * Deletes an action. */ deleteAction(input: AWS.SageMaker.DeleteActionRequest, options: SdkCallOptions): Promise; /** * Removes the specified algorithm from your account. */ deleteAlgorithm(input: AWS.SageMaker.DeleteAlgorithmInput, options: SdkCallOptions): Promise<{}>; /** * Used to stop and delete an app. */ deleteApp(input: AWS.SageMaker.DeleteAppRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an AppImageConfig. */ deleteAppImageConfig(input: AWS.SageMaker.DeleteAppImageConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an artifact. Either ArtifactArn or Source must be specified. */ deleteArtifact(input: AWS.SageMaker.DeleteArtifactRequest, options: SdkCallOptions): Promise; /** * Deletes an association. */ deleteAssociation(input: AWS.SageMaker.DeleteAssociationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified Git repository from your account. */ deleteCodeRepository(input: AWS.SageMaker.DeleteCodeRepositoryInput, options: SdkCallOptions): Promise<{}>; /** * Deletes an context. */ deleteContext(input: AWS.SageMaker.DeleteContextRequest, options: SdkCallOptions): Promise; /** * Deletes a data quality monitoring job definition. */ deleteDataQualityJobDefinition(input: AWS.SageMaker.DeleteDataQualityJobDefinitionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a fleet. */ deleteDeviceFleet(input: AWS.SageMaker.DeleteDeviceFleetRequest, options: SdkCallOptions): Promise<{}>; /** * Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts. */ deleteDomain(input: AWS.SageMaker.DeleteDomainRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan. */ deleteEdgeDeploymentPlan(input: AWS.SageMaker.DeleteEdgeDeploymentPlanRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a stage in an edge deployment plan if (and only if) the stage is inactive. */ deleteEdgeDeploymentStage(input: AWS.SageMaker.DeleteEdgeDeploymentStageRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created. SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call. When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources. */ deleteEndpoint(input: AWS.SageMaker.DeleteEndpointInput, options: SdkCallOptions): Promise<{}>; /** * Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges. */ deleteEndpointConfig(input: AWS.SageMaker.DeleteEndpointConfigInput, options: SdkCallOptions): Promise<{}>; /** * Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment. */ deleteExperiment(input: AWS.SageMaker.DeleteExperimentRequest, options: SdkCallOptions): Promise; /** * Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called. Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted. */ deleteFeatureGroup(input: AWS.SageMaker.DeleteFeatureGroupRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified flow definition. */ deleteFlowDefinition(input: AWS.SageMaker.DeleteFlowDefinitionRequest, options: SdkCallOptions): Promise; /** * Use this operation to delete a human task user interface (worker task template). To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis. */ deleteHumanTaskUi(input: AWS.SageMaker.DeleteHumanTaskUiRequest, options: SdkCallOptions): Promise; /** * Deletes a SageMaker image and all versions of the image. The container images aren't deleted. */ deleteImage(input: AWS.SageMaker.DeleteImageRequest, options: SdkCallOptions): Promise; /** * Deletes a version of a SageMaker image. The container image the version represents isn't deleted. */ deleteImageVersion(input: AWS.SageMaker.DeleteImageVersionRequest, options: SdkCallOptions): Promise; /** * Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model. */ deleteModel(input: AWS.SageMaker.DeleteModelInput, options: SdkCallOptions): Promise<{}>; /** * Deletes an Amazon SageMaker model bias job definition. */ deleteModelBiasJobDefinition(input: AWS.SageMaker.DeleteModelBiasJobDefinitionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an Amazon SageMaker model explainability job definition. */ deleteModelExplainabilityJobDefinition(input: AWS.SageMaker.DeleteModelExplainabilityJobDefinitionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a model package. A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker. */ deleteModelPackage(input: AWS.SageMaker.DeleteModelPackageInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified model group. */ deleteModelPackageGroup(input: AWS.SageMaker.DeleteModelPackageGroupInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a model group resource policy. */ deleteModelPackageGroupPolicy(input: AWS.SageMaker.DeleteModelPackageGroupPolicyInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the secified model quality monitoring job definition. */ deleteModelQualityJobDefinition(input: AWS.SageMaker.DeleteModelQualityJobDefinitionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule. */ deleteMonitoringSchedule(input: AWS.SageMaker.DeleteMonitoringScheduleRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API. When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance. */ deleteNotebookInstance(input: AWS.SageMaker.DeleteNotebookInstanceInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a notebook instance lifecycle configuration. */ deleteNotebookInstanceLifecycleConfig(input: AWS.SageMaker.DeleteNotebookInstanceLifecycleConfigInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted. */ deletePipeline(input: AWS.SageMaker.DeletePipelineRequest, options: SdkCallOptions): Promise; /** * Delete the specified project. */ deleteProject(input: AWS.SageMaker.DeleteProjectInput, options: SdkCallOptions): Promise<{}>; /** * Deletes the Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles. */ deleteStudioLifecycleConfig(input: AWS.SageMaker.DeleteStudioLifecycleConfigRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified tags from an SageMaker resource. To list a resource's tags, use the ListTags API. When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API. When you call this API to delete tags from a SageMaker Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API. */ deleteTags(input: AWS.SageMaker.DeleteTagsInput, options: SdkCallOptions): Promise; /** * Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components. */ deleteTrial(input: AWS.SageMaker.DeleteTrialRequest, options: SdkCallOptions): Promise; /** * Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API. */ deleteTrialComponent(input: AWS.SageMaker.DeleteTrialComponentRequest, options: SdkCallOptions): Promise; /** * Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts. */ deleteUserProfile(input: AWS.SageMaker.DeleteUserProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Use this operation to delete a workforce. If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use to create a new workforce. If a private workforce contains one or more work teams, you must use the operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error. */ deleteWorkforce(input: AWS.SageMaker.DeleteWorkforceRequest, options: SdkCallOptions): Promise; /** * Deletes an existing work team. This operation can't be undone. */ deleteWorkteam(input: AWS.SageMaker.DeleteWorkteamRequest, options: SdkCallOptions): Promise; /** * Deregisters the specified devices. After you deregister a device, you will need to re-register the devices. */ deregisterDevices(input: AWS.SageMaker.DeregisterDevicesRequest, options: SdkCallOptions): Promise<{}>; /** * Describes an action. */ describeAction(input: AWS.SageMaker.DescribeActionRequest, options: SdkCallOptions): Promise; /** * Returns a description of the specified algorithm that is in your account. */ describeAlgorithm(input: AWS.SageMaker.DescribeAlgorithmInput, options: SdkCallOptions): Promise; /** * Describes the app. */ describeApp(input: AWS.SageMaker.DescribeAppRequest, options: SdkCallOptions): Promise; /** * Describes an AppImageConfig. */ describeAppImageConfig(input: AWS.SageMaker.DescribeAppImageConfigRequest, options: SdkCallOptions): Promise; /** * Describes an artifact. */ describeArtifact(input: AWS.SageMaker.DescribeArtifactRequest, options: SdkCallOptions): Promise; /** * Returns information about an Amazon SageMaker AutoML job. */ describeAutoMLJob(input: AWS.SageMaker.DescribeAutoMLJobRequest, options: SdkCallOptions): Promise; /** * Gets details about the specified Git repository. */ describeCodeRepository(input: AWS.SageMaker.DescribeCodeRepositoryInput, options: SdkCallOptions): Promise; /** * Returns information about a model compilation job. To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs. */ describeCompilationJob(input: AWS.SageMaker.DescribeCompilationJobRequest, options: SdkCallOptions): Promise; /** * Describes a context. */ describeContext(input: AWS.SageMaker.DescribeContextRequest, options: SdkCallOptions): Promise; /** * Gets the details of a data quality monitoring job definition. */ describeDataQualityJobDefinition(input: AWS.SageMaker.DescribeDataQualityJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Describes the device. */ describeDevice(input: AWS.SageMaker.DescribeDeviceRequest, options: SdkCallOptions): Promise; /** * A description of the fleet the device belongs to. */ describeDeviceFleet(input: AWS.SageMaker.DescribeDeviceFleetRequest, options: SdkCallOptions): Promise; /** * The description of the domain. */ describeDomain(input: AWS.SageMaker.DescribeDomainRequest, options: SdkCallOptions): Promise; /** * Describes an edge deployment plan with deployment status per stage. */ describeEdgeDeploymentPlan(input: AWS.SageMaker.DescribeEdgeDeploymentPlanRequest, options: SdkCallOptions): Promise; /** * A description of edge packaging jobs. */ describeEdgePackagingJob(input: AWS.SageMaker.DescribeEdgePackagingJobRequest, options: SdkCallOptions): Promise; /** * Returns the description of an endpoint. */ describeEndpoint(input: AWS.SageMaker.DescribeEndpointInput, options: SdkCallOptions): Promise; /** * Returns the description of an endpoint configuration created using the CreateEndpointConfig API. */ describeEndpointConfig(input: AWS.SageMaker.DescribeEndpointConfigInput, options: SdkCallOptions): Promise; /** * Provides a list of an experiment's properties. */ describeExperiment(input: AWS.SageMaker.DescribeExperimentRequest, options: SdkCallOptions): Promise; /** * Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more. */ describeFeatureGroup(input: AWS.SageMaker.DescribeFeatureGroupRequest, options: SdkCallOptions): Promise; /** * Shows the metadata for a feature within a feature group. */ describeFeatureMetadata(input: AWS.SageMaker.DescribeFeatureMetadataRequest, options: SdkCallOptions): Promise; /** * Returns information about the specified flow definition. */ describeFlowDefinition(input: AWS.SageMaker.DescribeFlowDefinitionRequest, options: SdkCallOptions): Promise; /** * Returns information about the requested human task user interface (worker task template). */ describeHumanTaskUi(input: AWS.SageMaker.DescribeHumanTaskUiRequest, options: SdkCallOptions): Promise; /** * Gets a description of a hyperparameter tuning job. */ describeHyperParameterTuningJob(input: AWS.SageMaker.DescribeHyperParameterTuningJobRequest, options: SdkCallOptions): Promise; /** * Describes a SageMaker image. */ describeImage(input: AWS.SageMaker.DescribeImageRequest, options: SdkCallOptions): Promise; /** * Describes a version of a SageMaker image. */ describeImageVersion(input: AWS.SageMaker.DescribeImageVersionRequest, options: SdkCallOptions): Promise; /** * Provides the results of the Inference Recommender job. One or more recommendation jobs are returned. */ describeInferenceRecommendationsJob(input: AWS.SageMaker.DescribeInferenceRecommendationsJobRequest, options: SdkCallOptions): Promise; /** * Gets information about a labeling job. */ describeLabelingJob(input: AWS.SageMaker.DescribeLabelingJobRequest, options: SdkCallOptions): Promise; /** * Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide. */ describeLineageGroup(input: AWS.SageMaker.DescribeLineageGroupRequest, options: SdkCallOptions): Promise; /** * Describes a model that you created using the CreateModel API. */ describeModel(input: AWS.SageMaker.DescribeModelInput, options: SdkCallOptions): Promise; /** * Returns a description of a model bias job definition. */ describeModelBiasJobDefinition(input: AWS.SageMaker.DescribeModelBiasJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Returns a description of a model explainability job definition. */ describeModelExplainabilityJobDefinition(input: AWS.SageMaker.DescribeModelExplainabilityJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace. To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace. */ describeModelPackage(input: AWS.SageMaker.DescribeModelPackageInput, options: SdkCallOptions): Promise; /** * Gets a description for the specified model group. */ describeModelPackageGroup(input: AWS.SageMaker.DescribeModelPackageGroupInput, options: SdkCallOptions): Promise; /** * Returns a description of a model quality job definition. */ describeModelQualityJobDefinition(input: AWS.SageMaker.DescribeModelQualityJobDefinitionRequest, options: SdkCallOptions): Promise; /** * Describes the schedule for a monitoring job. */ describeMonitoringSchedule(input: AWS.SageMaker.DescribeMonitoringScheduleRequest, options: SdkCallOptions): Promise; /** * Returns information about a notebook instance. */ describeNotebookInstance(input: AWS.SageMaker.DescribeNotebookInstanceInput, options: SdkCallOptions): Promise; /** * Returns a description of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance. */ describeNotebookInstanceLifecycleConfig(input: AWS.SageMaker.DescribeNotebookInstanceLifecycleConfigInput, options: SdkCallOptions): Promise; /** * Describes the details of a pipeline. */ describePipeline(input: AWS.SageMaker.DescribePipelineRequest, options: SdkCallOptions): Promise; /** * Describes the details of an execution's pipeline definition. */ describePipelineDefinitionForExecution(input: AWS.SageMaker.DescribePipelineDefinitionForExecutionRequest, options: SdkCallOptions): Promise; /** * Describes the details of a pipeline execution. */ describePipelineExecution(input: AWS.SageMaker.DescribePipelineExecutionRequest, options: SdkCallOptions): Promise; /** * Returns a description of a processing job. */ describeProcessingJob(input: AWS.SageMaker.DescribeProcessingJobRequest, options: SdkCallOptions): Promise; /** * Describes the details of a project. */ describeProject(input: AWS.SageMaker.DescribeProjectInput, options: SdkCallOptions): Promise; /** * Describes the Studio Lifecycle Configuration. */ describeStudioLifecycleConfig(input: AWS.SageMaker.DescribeStudioLifecycleConfigRequest, options: SdkCallOptions): Promise; /** * Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace. */ describeSubscribedWorkteam(input: AWS.SageMaker.DescribeSubscribedWorkteamRequest, options: SdkCallOptions): Promise; /** * Returns information about a training job. Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response. */ describeTrainingJob(input: AWS.SageMaker.DescribeTrainingJobRequest, options: SdkCallOptions): Promise; /** * Returns information about a transform job. */ describeTransformJob(input: AWS.SageMaker.DescribeTransformJobRequest, options: SdkCallOptions): Promise; /** * Provides a list of a trial's properties. */ describeTrial(input: AWS.SageMaker.DescribeTrialRequest, options: SdkCallOptions): Promise; /** * Provides a list of a trials component's properties. */ describeTrialComponent(input: AWS.SageMaker.DescribeTrialComponentRequest, options: SdkCallOptions): Promise; /** * Describes a user profile. For more information, see CreateUserProfile. */ describeUserProfile(input: AWS.SageMaker.DescribeUserProfileRequest, options: SdkCallOptions): Promise; /** * Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks. This operation applies only to private workforces. */ describeWorkforce(input: AWS.SageMaker.DescribeWorkforceRequest, options: SdkCallOptions): Promise; /** * Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN). */ describeWorkteam(input: AWS.SageMaker.DescribeWorkteamRequest, options: SdkCallOptions): Promise; /** * Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. */ disableSagemakerServicecatalogPortfolio(input: AWS.SageMaker.DisableSagemakerServicecatalogPortfolioInput, options: SdkCallOptions): Promise; /** * Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API. To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents. */ disassociateTrialComponent(input: AWS.SageMaker.DisassociateTrialComponentRequest, options: SdkCallOptions): Promise; /** * Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. */ enableSagemakerServicecatalogPortfolio(input: AWS.SageMaker.EnableSagemakerServicecatalogPortfolioInput, options: SdkCallOptions): Promise; /** * Describes a fleet. */ getDeviceFleetReport(input: AWS.SageMaker.GetDeviceFleetReportRequest, options: SdkCallOptions): Promise; /** * The resource policy for the lineage group. */ getLineageGroupPolicy(input: AWS.SageMaker.GetLineageGroupPolicyRequest, options: SdkCallOptions): Promise; /** * Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide.. */ getModelPackageGroupPolicy(input: AWS.SageMaker.GetModelPackageGroupPolicyInput, options: SdkCallOptions): Promise; /** * Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. */ getSagemakerServicecatalogPortfolioStatus(input: AWS.SageMaker.GetSagemakerServicecatalogPortfolioStatusInput, options: SdkCallOptions): Promise; /** * An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics. */ getSearchSuggestions(input: AWS.SageMaker.GetSearchSuggestionsRequest, options: SdkCallOptions): Promise; /** * Lists the actions in your account and their properties. */ listActions(input: AWS.SageMaker.ListActionsRequest, options: SdkCallOptions): Promise; /** * Lists the machine learning algorithms that have been created. */ listAlgorithms(input: AWS.SageMaker.ListAlgorithmsInput, options: SdkCallOptions): Promise; /** * Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string. */ listAppImageConfigs(input: AWS.SageMaker.ListAppImageConfigsRequest, options: SdkCallOptions): Promise; /** * Lists apps. */ listApps(input: AWS.SageMaker.ListAppsRequest, options: SdkCallOptions): Promise; /** * Lists the artifacts in your account and their properties. */ listArtifacts(input: AWS.SageMaker.ListArtifactsRequest, options: SdkCallOptions): Promise; /** * Lists the associations in your account and their properties. */ listAssociations(input: AWS.SageMaker.ListAssociationsRequest, options: SdkCallOptions): Promise; /** * Request a list of jobs. */ listAutoMLJobs(input: AWS.SageMaker.ListAutoMLJobsRequest, options: SdkCallOptions): Promise; /** * List the candidates created for the job. */ listCandidatesForAutoMLJob(input: AWS.SageMaker.ListCandidatesForAutoMLJobRequest, options: SdkCallOptions): Promise; /** * Gets a list of the Git repositories in your account. */ listCodeRepositories(input: AWS.SageMaker.ListCodeRepositoriesInput, options: SdkCallOptions): Promise; /** * Lists model compilation jobs that satisfy various filters. To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob. */ listCompilationJobs(input: AWS.SageMaker.ListCompilationJobsRequest, options: SdkCallOptions): Promise; /** * Lists the contexts in your account and their properties. */ listContexts(input: AWS.SageMaker.ListContextsRequest, options: SdkCallOptions): Promise; /** * Lists the data quality job definitions in your account. */ listDataQualityJobDefinitions(input: AWS.SageMaker.ListDataQualityJobDefinitionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of devices in the fleet. */ listDeviceFleets(input: AWS.SageMaker.ListDeviceFleetsRequest, options: SdkCallOptions): Promise; /** * A list of devices. */ listDevices(input: AWS.SageMaker.ListDevicesRequest, options: SdkCallOptions): Promise; /** * Lists the domains. */ listDomains(input: AWS.SageMaker.ListDomainsRequest, options: SdkCallOptions): Promise; /** * Lists all edge deployment plans. */ listEdgeDeploymentPlans(input: AWS.SageMaker.ListEdgeDeploymentPlansRequest, options: SdkCallOptions): Promise; /** * Returns a list of edge packaging jobs. */ listEdgePackagingJobs(input: AWS.SageMaker.ListEdgePackagingJobsRequest, options: SdkCallOptions): Promise; /** * Lists endpoint configurations. */ listEndpointConfigs(input: AWS.SageMaker.ListEndpointConfigsInput, options: SdkCallOptions): Promise; /** * Lists endpoints. */ listEndpoints(input: AWS.SageMaker.ListEndpointsInput, options: SdkCallOptions): Promise; /** * Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time. */ listExperiments(input: AWS.SageMaker.ListExperimentsRequest, options: SdkCallOptions): Promise; /** * List FeatureGroups based on given filter and order. */ listFeatureGroups(input: AWS.SageMaker.ListFeatureGroupsRequest, options: SdkCallOptions): Promise; /** * Returns information about the flow definitions in your account. */ listFlowDefinitions(input: AWS.SageMaker.ListFlowDefinitionsRequest, options: SdkCallOptions): Promise; /** * Returns information about the human task user interfaces in your account. */ listHumanTaskUis(input: AWS.SageMaker.ListHumanTaskUisRequest, options: SdkCallOptions): Promise; /** * Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account. */ listHyperParameterTuningJobs(input: AWS.SageMaker.ListHyperParameterTuningJobsRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time. */ listImageVersions(input: AWS.SageMaker.ListImageVersionsRequest, options: SdkCallOptions): Promise; /** * Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string. */ listImages(input: AWS.SageMaker.ListImagesRequest, options: SdkCallOptions): Promise; /** * Lists recommendation jobs that satisfy various filters. */ listInferenceRecommendationsJobs(input: AWS.SageMaker.ListInferenceRecommendationsJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of labeling jobs. */ listLabelingJobs(input: AWS.SageMaker.ListLabelingJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of labeling jobs assigned to a specified work team. */ listLabelingJobsForWorkteam(input: AWS.SageMaker.ListLabelingJobsForWorkteamRequest, options: SdkCallOptions): Promise; /** * A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide. */ listLineageGroups(input: AWS.SageMaker.ListLineageGroupsRequest, options: SdkCallOptions): Promise; /** * Lists model bias jobs definitions that satisfy various filters. */ listModelBiasJobDefinitions(input: AWS.SageMaker.ListModelBiasJobDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists model explainability job definitions that satisfy various filters. */ listModelExplainabilityJobDefinitions(input: AWS.SageMaker.ListModelExplainabilityJobDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos. */ listModelMetadata(input: AWS.SageMaker.ListModelMetadataRequest, options: SdkCallOptions): Promise; /** * Gets a list of the model groups in your Amazon Web Services account. */ listModelPackageGroups(input: AWS.SageMaker.ListModelPackageGroupsInput, options: SdkCallOptions): Promise; /** * Lists the model packages that have been created. */ listModelPackages(input: AWS.SageMaker.ListModelPackagesInput, options: SdkCallOptions): Promise; /** * Gets a list of model quality monitoring job definitions in your account. */ listModelQualityJobDefinitions(input: AWS.SageMaker.ListModelQualityJobDefinitionsRequest, options: SdkCallOptions): Promise; /** * Lists models created with the CreateModel API. */ listModels(input: AWS.SageMaker.ListModelsInput, options: SdkCallOptions): Promise; /** * Returns list of all monitoring job executions. */ listMonitoringExecutions(input: AWS.SageMaker.ListMonitoringExecutionsRequest, options: SdkCallOptions): Promise; /** * Returns list of all monitoring schedules. */ listMonitoringSchedules(input: AWS.SageMaker.ListMonitoringSchedulesRequest, options: SdkCallOptions): Promise; /** * Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API. */ listNotebookInstanceLifecycleConfigs(input: AWS.SageMaker.ListNotebookInstanceLifecycleConfigsInput, options: SdkCallOptions): Promise; /** * Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region. */ listNotebookInstances(input: AWS.SageMaker.ListNotebookInstancesInput, options: SdkCallOptions): Promise; /** * Gets a list of PipeLineExecutionStep objects. */ listPipelineExecutionSteps(input: AWS.SageMaker.ListPipelineExecutionStepsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the pipeline executions. */ listPipelineExecutions(input: AWS.SageMaker.ListPipelineExecutionsRequest, options: SdkCallOptions): Promise; /** * Gets a list of parameters for a pipeline execution. */ listPipelineParametersForExecution(input: AWS.SageMaker.ListPipelineParametersForExecutionRequest, options: SdkCallOptions): Promise; /** * Gets a list of pipelines. */ listPipelines(input: AWS.SageMaker.ListPipelinesRequest, options: SdkCallOptions): Promise; /** * Lists processing jobs that satisfy various filters. */ listProcessingJobs(input: AWS.SageMaker.ListProcessingJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the projects in an Amazon Web Services account. */ listProjects(input: AWS.SageMaker.ListProjectsInput, options: SdkCallOptions): Promise; /** * Lists devices allocated to the stage, containing detailed device information and deployment status. */ listStageDevices(input: AWS.SageMaker.ListStageDevicesRequest, options: SdkCallOptions): Promise; /** * Lists the Studio Lifecycle Configurations in your Amazon Web Services Account. */ listStudioLifecycleConfigs(input: AWS.SageMaker.ListStudioLifecycleConfigsRequest, options: SdkCallOptions): Promise; /** * Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter. */ listSubscribedWorkteams(input: AWS.SageMaker.ListSubscribedWorkteamsRequest, options: SdkCallOptions): Promise; /** * Returns the tags for the specified SageMaker resource. */ listTags(input: AWS.SageMaker.ListTagsInput, options: SdkCallOptions): Promise; /** * Lists training jobs. When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response. For example, if ListTrainingJobs is invoked with the following parameters: { ... MaxResults: 100, StatusEquals: InProgress ... } First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned. You can quickly test the API using the following Amazon Web Services CLI code. aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress */ listTrainingJobs(input: AWS.SageMaker.ListTrainingJobsRequest, options: SdkCallOptions): Promise; /** * Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched. */ listTrainingJobsForHyperParameterTuningJob(input: AWS.SageMaker.ListTrainingJobsForHyperParameterTuningJobRequest, options: SdkCallOptions): Promise; /** * Lists transform jobs. */ listTransformJobs(input: AWS.SageMaker.ListTransformJobsRequest, options: SdkCallOptions): Promise; /** * Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following: ExperimentName SourceArn TrialName */ listTrialComponents(input: AWS.SageMaker.ListTrialComponentsRequest, options: SdkCallOptions): Promise; /** * Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time. */ listTrials(input: AWS.SageMaker.ListTrialsRequest, options: SdkCallOptions): Promise; /** * Lists user profiles. */ listUserProfiles(input: AWS.SageMaker.ListUserProfilesRequest, options: SdkCallOptions): Promise; /** * Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region. */ listWorkforces(input: AWS.SageMaker.ListWorkforcesRequest, options: SdkCallOptions): Promise; /** * Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter. */ listWorkteams(input: AWS.SageMaker.ListWorkteamsRequest, options: SdkCallOptions): Promise; /** * Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide.. */ putModelPackageGroupPolicy(input: AWS.SageMaker.PutModelPackageGroupPolicyInput, options: SdkCallOptions): Promise; /** * Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide. */ queryLineage(input: AWS.SageMaker.QueryLineageRequest, options: SdkCallOptions): Promise; /** * Register devices. */ registerDevices(input: AWS.SageMaker.RegisterDevicesRequest, options: SdkCallOptions): Promise<{}>; /** * Renders the UI template so that you can preview the worker's experience. */ renderUiTemplate(input: AWS.SageMaker.RenderUiTemplateRequest, options: SdkCallOptions): Promise; /** * Retry the execution of the pipeline. */ retryPipelineExecution(input: AWS.SageMaker.RetryPipelineExecutionRequest, options: SdkCallOptions): Promise; /** * Finds Amazon SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order. You can query against the following value types: numeric, text, Boolean, and timestamp. */ search(input: AWS.SageMaker.SearchRequest, options: SdkCallOptions): Promise; /** * Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS). */ sendPipelineExecutionStepFailure(input: AWS.SageMaker.SendPipelineExecutionStepFailureRequest, options: SdkCallOptions): Promise; /** * Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS). */ sendPipelineExecutionStepSuccess(input: AWS.SageMaker.SendPipelineExecutionStepSuccessRequest, options: SdkCallOptions): Promise; /** * Starts a stage in an edge deployment plan. */ startEdgeDeploymentStage(input: AWS.SageMaker.StartEdgeDeploymentStageRequest, options: SdkCallOptions): Promise<{}>; /** * Starts a previously stopped monitoring schedule. By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled. */ startMonitoringSchedule(input: AWS.SageMaker.StartMonitoringScheduleRequest, options: SdkCallOptions): Promise<{}>; /** * Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook. */ startNotebookInstance(input: AWS.SageMaker.StartNotebookInstanceInput, options: SdkCallOptions): Promise<{}>; /** * Starts a pipeline execution. */ startPipelineExecution(input: AWS.SageMaker.StartPipelineExecutionRequest, options: SdkCallOptions): Promise; /** * A method for forcing the termination of a running job. */ stopAutoMLJob(input: AWS.SageMaker.StopAutoMLJobRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a model compilation job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal. When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped. */ stopCompilationJob(input: AWS.SageMaker.StopCompilationJobRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a stage in an edge deployment plan. */ stopEdgeDeploymentStage(input: AWS.SageMaker.StopEdgeDeploymentStageRequest, options: SdkCallOptions): Promise<{}>; /** * Request to stop an edge packaging job. */ stopEdgePackagingJob(input: AWS.SageMaker.StopEdgePackagingJobRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched. All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job. */ stopHyperParameterTuningJob(input: AWS.SageMaker.StopHyperParameterTuningJobRequest, options: SdkCallOptions): Promise<{}>; /** * Stops an Inference Recommender job. */ stopInferenceRecommendationsJob(input: AWS.SageMaker.StopInferenceRecommendationsJobRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket. */ stopLabelingJob(input: AWS.SageMaker.StopLabelingJobRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a previously started monitoring schedule. */ stopMonitoringSchedule(input: AWS.SageMaker.StopMonitoringScheduleRequest, options: SdkCallOptions): Promise<{}>; /** * Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance. To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work. */ stopNotebookInstance(input: AWS.SageMaker.StopNotebookInstanceInput, options: SdkCallOptions): Promise<{}>; /** * Stops a pipeline execution. Callback Step A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping". You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure. Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution. Lambda Step A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed. */ stopPipelineExecution(input: AWS.SageMaker.StopPipelineExecutionRequest, options: SdkCallOptions): Promise; /** * Stops a processing job. */ stopProcessingJob(input: AWS.SageMaker.StopProcessingJobRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped. */ stopTrainingJob(input: AWS.SageMaker.StopTrainingJobRequest, options: SdkCallOptions): Promise<{}>; /** * Stops a batch transform job. When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3. */ stopTransformJob(input: AWS.SageMaker.StopTransformJobRequest, options: SdkCallOptions): Promise<{}>; /** * Updates an action. */ updateAction(input: AWS.SageMaker.UpdateActionRequest, options: SdkCallOptions): Promise; /** * Updates the properties of an AppImageConfig. */ updateAppImageConfig(input: AWS.SageMaker.UpdateAppImageConfigRequest, options: SdkCallOptions): Promise; /** * Updates an artifact. */ updateArtifact(input: AWS.SageMaker.UpdateArtifactRequest, options: SdkCallOptions): Promise; /** * Updates the specified Git repository with the specified values. */ updateCodeRepository(input: AWS.SageMaker.UpdateCodeRepositoryInput, options: SdkCallOptions): Promise; /** * Updates a context. */ updateContext(input: AWS.SageMaker.UpdateContextRequest, options: SdkCallOptions): Promise; /** * Updates a fleet of devices. */ updateDeviceFleet(input: AWS.SageMaker.UpdateDeviceFleetRequest, options: SdkCallOptions): Promise<{}>; /** * Updates one or more devices in a fleet. */ updateDevices(input: AWS.SageMaker.UpdateDevicesRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the default settings for new user profiles in the domain. */ updateDomain(input: AWS.SageMaker.UpdateDomainRequest, options: SdkCallOptions): Promise; /** * Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss). When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges. */ updateEndpoint(input: AWS.SageMaker.UpdateEndpointInput, options: SdkCallOptions): Promise; /** * Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. */ updateEndpointWeightsAndCapacities(input: AWS.SageMaker.UpdateEndpointWeightsAndCapacitiesInput, options: SdkCallOptions): Promise; /** * Adds, updates, or removes the description of an experiment. Updates the display name of an experiment. */ updateExperiment(input: AWS.SageMaker.UpdateExperimentRequest, options: SdkCallOptions): Promise; /** * Updates the feature group. */ updateFeatureGroup(input: AWS.SageMaker.UpdateFeatureGroupRequest, options: SdkCallOptions): Promise; /** * Updates the description and parameters of the feature group. */ updateFeatureMetadata(input: AWS.SageMaker.UpdateFeatureMetadataRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs. */ updateImage(input: AWS.SageMaker.UpdateImageRequest, options: SdkCallOptions): Promise; /** * Updates a versioned model. */ updateModelPackage(input: AWS.SageMaker.UpdateModelPackageInput, options: SdkCallOptions): Promise; /** * Updates a previously created schedule. */ updateMonitoringSchedule(input: AWS.SageMaker.UpdateMonitoringScheduleRequest, options: SdkCallOptions): Promise; /** * Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements. */ updateNotebookInstance(input: AWS.SageMaker.UpdateNotebookInstanceInput, options: SdkCallOptions): Promise; /** * Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API. */ updateNotebookInstanceLifecycleConfig(input: AWS.SageMaker.UpdateNotebookInstanceLifecycleConfigInput, options: SdkCallOptions): Promise; /** * Updates a pipeline. */ updatePipeline(input: AWS.SageMaker.UpdatePipelineRequest, options: SdkCallOptions): Promise; /** * Updates a pipeline execution. */ updatePipelineExecution(input: AWS.SageMaker.UpdatePipelineExecutionRequest, options: SdkCallOptions): Promise; /** * Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model. You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project. */ updateProject(input: AWS.SageMaker.UpdateProjectInput, options: SdkCallOptions): Promise; /** * Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length. */ updateTrainingJob(input: AWS.SageMaker.UpdateTrainingJobRequest, options: SdkCallOptions): Promise; /** * Updates the display name of a trial. */ updateTrial(input: AWS.SageMaker.UpdateTrialRequest, options: SdkCallOptions): Promise; /** * Updates one or more properties of a trial component. */ updateTrialComponent(input: AWS.SageMaker.UpdateTrialComponentRequest, options: SdkCallOptions): Promise; /** * Updates a user profile. */ updateUserProfile(input: AWS.SageMaker.UpdateUserProfileRequest, options: SdkCallOptions): Promise; /** * Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration. The worker portal is now supported in VPC and public internet. Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal. To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "0.0.0.0/0". Amazon SageMaker does not support Source Ip restriction for worker portals in VPC. Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP. You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the operation. After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the operation. This operation only applies to private workforces. */ updateWorkforce(input: AWS.SageMaker.UpdateWorkforceRequest, options: SdkCallOptions): Promise; /** * Updates an existing work team with new member definitions or description. */ updateWorkteam(input: AWS.SageMaker.UpdateWorkteamRequest, options: SdkCallOptions): Promise; } export interface SagemakerEdge { /** * Use to get the active deployments from a device. */ getDeployments(input: AWS.SagemakerEdge.GetDeploymentsRequest, options: SdkCallOptions): Promise; /** * Use to check if a device is registered with SageMaker Edge Manager. */ getDeviceRegistration(input: AWS.SagemakerEdge.GetDeviceRegistrationRequest, options: SdkCallOptions): Promise; /** * Use to get the current status of devices registered on SageMaker Edge Manager. */ sendHeartbeat(input: AWS.SagemakerEdge.SendHeartbeatRequest, options: SdkCallOptions): Promise<{}>; } export interface SageMakerFeatureStoreRuntime { /** * Retrieves a batch of Records from a FeatureGroup. */ batchGetRecord(input: AWS.SageMakerFeatureStoreRuntime.BatchGetRecordRequest, options: SdkCallOptions): Promise; /** * Deletes a Record from a FeatureGroup. A new record will show up in the OfflineStore when the DeleteRecord API is called. This record will have a value of True in the is_deleted column. */ deleteRecord(input: AWS.SageMakerFeatureStoreRuntime.DeleteRecordRequest, options: SdkCallOptions): Promise<{}>; /** * Use for OnlineStore serving from a FeatureStore. Only the latest records stored in the OnlineStore can be retrieved. If no Record with RecordIdentifierValue is found, then an empty result is returned. */ getRecord(input: AWS.SageMakerFeatureStoreRuntime.GetRecordRequest, options: SdkCallOptions): Promise; /** * Used for data ingestion into the FeatureStore. The PutRecord API writes to both the OnlineStore and OfflineStore. If the record is the latest record for the recordIdentifier, the record is written to both the OnlineStore and OfflineStore. If the record is a historic record, it is written only to the OfflineStore. */ putRecord(input: AWS.SageMakerFeatureStoreRuntime.PutRecordRequest, options: SdkCallOptions): Promise<{}>; } export interface SageMakerRuntime { /** * After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint. For an overview of Amazon SageMaker, see How It Works. Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Calls to InvokeEndpoint are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds. Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller. */ invokeEndpoint(input: AWS.SageMakerRuntime.InvokeEndpointInput, options: SdkCallOptions): Promise; /** * After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner. Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before the you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it. Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. */ invokeEndpointAsync(input: AWS.SageMakerRuntime.InvokeEndpointAsyncInput, options: SdkCallOptions): Promise; } export interface SavingsPlans { /** * Creates a Savings Plan. */ createSavingsPlan(input: AWS.SavingsPlans.CreateSavingsPlanRequest, options: SdkCallOptions): Promise; /** * Deletes the queued purchase for the specified Savings Plan. */ deleteQueuedSavingsPlan(input: AWS.SavingsPlans.DeleteQueuedSavingsPlanRequest, options: SdkCallOptions): Promise; /** * Describes the specified Savings Plans rates. */ describeSavingsPlanRates(input: AWS.SavingsPlans.DescribeSavingsPlanRatesRequest, options: SdkCallOptions): Promise; /** * Describes the specified Savings Plans. */ describeSavingsPlans(input: AWS.SavingsPlans.DescribeSavingsPlansRequest, options: SdkCallOptions): Promise; /** * Describes the specified Savings Plans offering rates. */ describeSavingsPlansOfferingRates(input: AWS.SavingsPlans.DescribeSavingsPlansOfferingRatesRequest, options: SdkCallOptions): Promise; /** * Describes the specified Savings Plans offerings. */ describeSavingsPlansOfferings(input: AWS.SavingsPlans.DescribeSavingsPlansOfferingsRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.SavingsPlans.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified resource. */ tagResource(input: AWS.SavingsPlans.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified resource. */ untagResource(input: AWS.SavingsPlans.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface Schemas { /** * Creates a discoverer. */ createDiscoverer(input: AWS.Schemas.CreateDiscovererRequest, options: SdkCallOptions): Promise; /** * Creates a registry. */ createRegistry(input: AWS.Schemas.CreateRegistryRequest, options: SdkCallOptions): Promise; /** * Creates a schema definition. Inactive schemas will be deleted after two years. */ createSchema(input: AWS.Schemas.CreateSchemaRequest, options: SdkCallOptions): Promise; /** * Deletes a discoverer. */ deleteDiscoverer(input: AWS.Schemas.DeleteDiscovererRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a Registry. */ deleteRegistry(input: AWS.Schemas.DeleteRegistryRequest, options: SdkCallOptions): Promise<{}>; /** * Delete the resource-based policy attached to the specified registry. */ deleteResourcePolicy(input: AWS.Schemas.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise<{}>; /** * Delete a schema definition. */ deleteSchema(input: AWS.Schemas.DeleteSchemaRequest, options: SdkCallOptions): Promise<{}>; /** * Delete the schema version definition */ deleteSchemaVersion(input: AWS.Schemas.DeleteSchemaVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Describe the code binding URI. */ describeCodeBinding(input: AWS.Schemas.DescribeCodeBindingRequest, options: SdkCallOptions): Promise; /** * Describes the discoverer. */ describeDiscoverer(input: AWS.Schemas.DescribeDiscovererRequest, options: SdkCallOptions): Promise; /** * Describes the registry. */ describeRegistry(input: AWS.Schemas.DescribeRegistryRequest, options: SdkCallOptions): Promise; /** * Retrieve the schema definition. */ describeSchema(input: AWS.Schemas.DescribeSchemaRequest, options: SdkCallOptions): Promise; exportSchema(input: AWS.Schemas.ExportSchemaRequest, options: SdkCallOptions): Promise; /** * Get the code binding source URI. */ getCodeBindingSource(input: AWS.Schemas.GetCodeBindingSourceRequest, options: SdkCallOptions): Promise; /** * Get the discovered schema that was generated based on sampled events. */ getDiscoveredSchema(input: AWS.Schemas.GetDiscoveredSchemaRequest, options: SdkCallOptions): Promise; /** * Retrieves the resource-based policy attached to a given registry. */ getResourcePolicy(input: AWS.Schemas.GetResourcePolicyRequest, options: SdkCallOptions): Promise; /** * List the discoverers. */ listDiscoverers(input: AWS.Schemas.ListDiscoverersRequest, options: SdkCallOptions): Promise; /** * List the registries. */ listRegistries(input: AWS.Schemas.ListRegistriesRequest, options: SdkCallOptions): Promise; /** * Provides a list of the schema versions and related information. */ listSchemaVersions(input: AWS.Schemas.ListSchemaVersionsRequest, options: SdkCallOptions): Promise; /** * List the schemas. */ listSchemas(input: AWS.Schemas.ListSchemasRequest, options: SdkCallOptions): Promise; /** * Get tags for resource. */ listTagsForResource(input: AWS.Schemas.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Put code binding URI */ putCodeBinding(input: AWS.Schemas.PutCodeBindingRequest, options: SdkCallOptions): Promise; /** * The name of the policy. */ putResourcePolicy(input: AWS.Schemas.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Search the schemas */ searchSchemas(input: AWS.Schemas.SearchSchemasRequest, options: SdkCallOptions): Promise; /** * Starts the discoverer */ startDiscoverer(input: AWS.Schemas.StartDiscovererRequest, options: SdkCallOptions): Promise; /** * Stops the discoverer */ stopDiscoverer(input: AWS.Schemas.StopDiscovererRequest, options: SdkCallOptions): Promise; /** * Add tags to a resource. */ tagResource(input: AWS.Schemas.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes tags from a resource. */ untagResource(input: AWS.Schemas.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the discoverer */ updateDiscoverer(input: AWS.Schemas.UpdateDiscovererRequest, options: SdkCallOptions): Promise; /** * Updates a registry. */ updateRegistry(input: AWS.Schemas.UpdateRegistryRequest, options: SdkCallOptions): Promise; /** * Updates the schema definition Inactive schemas will be deleted after two years. */ updateSchema(input: AWS.Schemas.UpdateSchemaRequest, options: SdkCallOptions): Promise; } export interface SecretsManager { /** * Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation. If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works. To turn on automatic rotation again, call RotateSecret. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ cancelRotateSecret(input: AWS.SecretsManager.CancelRotateSecretRequest, options: SdkCallOptions): Promise; /** * Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret. For information about creating a secret in the console, see Create a secret. To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it. For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret. If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result. If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key. */ createSecret(input: AWS.SecretsManager.CreateSecretRequest, options: SdkCallOptions): Promise; /** * Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:DeleteResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ deleteResourcePolicy(input: AWS.SecretsManager.DeleteResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently. You can't delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately. You can't directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background. To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion. Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur. At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret. When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ deleteSecret(input: AWS.SecretsManager.DeleteSecretRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:DescribeSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ describeSecret(input: AWS.SecretsManager.DescribeSecretRequest, options: SdkCallOptions): Promise; /** * Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ getRandomPassword(input: AWS.SecretsManager.GetRandomPasswordRequest, options: SdkCallOptions): Promise; /** * Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:GetResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ getResourcePolicy(input: AWS.SecretsManager.GetResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content. We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications. To retrieve the previous version of a secret, use VersionStage and specify AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:GetSecretValue. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ getSecretValue(input: AWS.SecretsManager.GetSecretValueRequest, options: SdkCallOptions): Promise; /** * Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions. To list the secrets in the account, use ListSecrets. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ listSecretVersionIds(input: AWS.SecretsManager.ListSecretVersionIdsRequest, options: SdkCallOptions): Promise; /** * Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console. ListSecrets is eventually consistent, however it might not reflect changes from the last five minutes. To get the latest information for a specific secret, use DescribeSecret. To list the versions of a secret, use ListSecretVersionIds. To get the secret value from SecretString or SecretBinary, call GetSecretValue. For information about finding secrets in the console, see Find secrets in Secrets Manager. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:ListSecrets. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ listSecrets(input: AWS.SecretsManager.ListSecretsRequest, options: SdkCallOptions): Promise; /** * Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager For information about attaching a policy in the console, see Attach a permissions policy to a secret. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ putResourcePolicy(input: AWS.SecretsManager.PutResourcePolicyRequest, options: SdkCallOptions): Promise; /** * Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions. You can specify the staging labels to attach to the new version in VersionStages. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it. If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is idempotent. If you call this operation with a ClientRequestToken that matches an existing version's VersionId, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ putSecretValue(input: AWS.SecretsManager.PutSecretValueRequest, options: SdkCallOptions): Promise; /** * For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ removeRegionsFromReplication(input: AWS.SecretsManager.RemoveRegionsFromReplicationRequest, options: SdkCallOptions): Promise; /** * Replicates the secret to a new Regions. See Multi-Region secrets. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ replicateSecretToRegions(input: AWS.SecretsManager.ReplicateSecretToRegionsRequest, options: SdkCallOptions): Promise; /** * Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ restoreSecret(input: AWS.SecretsManager.RestoreSecretRequest, options: SdkCallOptions): Promise; /** * Configures and starts the asynchronous process of rotating the secret. For more information about rotation, see Rotate secrets. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the secret value is in the JSON structure of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser secret. To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works. You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose a template that matches your Rotation strategy. When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation. */ rotateSecret(input: AWS.SecretsManager.RotateSecretRequest, options: SdkCallOptions): Promise; /** * Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region. You must call this operation from the Region in which you want to promote the replica to a primary secret. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:StopReplicationToReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ stopReplicationToReplica(input: AWS.SecretsManager.StopReplicationToReplicaRequest, options: SdkCallOptions): Promise; /** * Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags. The following restrictions apply to tags: Maximum number of tags per secret: 50 Maximum key length: 127 Unicode characters in UTF-8 Maximum value length: 255 Unicode characters in UTF-8 Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ tagResource(input: AWS.SecretsManager.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Removes specific tags from a secret. This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged. If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:UntagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ untagResource(input: AWS.SecretsManager.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue. To change the rotation configuration of a secret, use RotateSecret instead. We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions. If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed from. If you call this operation with a ClientRequestToken that matches an existing version's VersionId, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:UpdateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey and kms:Decrypt permissions on the key. For more information, see Secret encryption and decryption. */ updateSecret(input: AWS.SecretsManager.UpdateSecretRequest, options: SdkCallOptions): Promise; /** * Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version. The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version. You can move the AWSCURRENT staging label to this version by including it in this call. Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from. If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:UpdateSecretVersionStage. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ updateSecretVersionStage(input: AWS.SecretsManager.UpdateSecretVersionStageRequest, options: SdkCallOptions): Promise; /** * Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets. The API performs three checks when validating the policy: Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal. Checks for correct syntax in a policy. Verifies the policy does not lock out a caller. Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:ValidateResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. */ validateResourcePolicy(input: AWS.SecretsManager.ValidateResourcePolicyRequest, options: SdkCallOptions): Promise; } export interface SecurityHub { /** * Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account. */ acceptAdministratorInvitation(input: AWS.SecurityHub.AcceptAdministratorInvitationRequest, options: SdkCallOptions): Promise; /** * This method is deprecated. Instead, use AcceptAdministratorInvitation. The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation. Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account. */ acceptInvitation(input: AWS.SecurityHub.AcceptInvitationRequest, options: SdkCallOptions): Promise; /** * Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Security Standards section of the Security Hub User Guide. */ batchDisableStandards(input: AWS.SecurityHub.BatchDisableStandardsRequest, options: SdkCallOptions): Promise; /** * Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation. For more information, see the Security Standards section of the Security Hub User Guide. */ batchEnableStandards(input: AWS.SecurityHub.BatchEnableStandardsRequest, options: SdkCallOptions): Promise; /** * Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub. BatchImportFindings must be called by one of the following: The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling BatchImportFindings from needs to be the same as the AwsAccountId attribute for the finding. An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call BatchImportFindings from the allow-listed account and send findings from different customer accounts in the same batch. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb. After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow. Note UserDefinedFields VerificationState Workflow Finding providers also should not use BatchImportFindings to update the following attributes. Confidence Criticality RelatedFindings Severity Types Instead, finding providers use FindingProviderFields to provide values for these attributes. */ batchImportFindings(input: AWS.SecurityHub.BatchImportFindingsRequest, options: SdkCallOptions): Promise; /** * Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding. Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects. Confidence Criticality Note RelatedFindings Severity Types UserDefinedFields VerificationState Workflow You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide. */ batchUpdateFindings(input: AWS.SecurityHub.BatchUpdateFindingsRequest, options: SdkCallOptions): Promise; /** * Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events. */ createActionTarget(input: AWS.SecurityHub.CreateActionTargetRequest, options: SdkCallOptions): Promise; /** * Used to enable finding aggregation. Must be called from the aggregation Region. For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide. */ createFindingAggregator(input: AWS.SecurityHub.CreateFindingAggregatorRequest, options: SdkCallOptions): Promise; /** * Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. To group the related findings in the insight, use the GroupByAttribute. */ createInsight(input: AWS.SecurityHub.CreateInsightRequest, options: SdkCallOptions): Promise; /** * Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account. CreateMembers is always used to add accounts that are not organization members. For accounts that are managed using Organizations, CreateMembers is only used in the following cases: Security Hub is not configured to automatically add new organization accounts. The account was disassociated or deleted in Security Hub. This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation. For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub. Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub. If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account. For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls. A permissions policy is added that permits the administrator account to view the findings generated in the member account. To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation. */ createMembers(input: AWS.SecurityHub.CreateMembersRequest, options: SdkCallOptions): Promise; /** * Declines invitations to become a member account. This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations. */ declineInvitations(input: AWS.SecurityHub.DeclineInvitationsRequest, options: SdkCallOptions): Promise; /** * Deletes a custom action target from Security Hub. Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action. */ deleteActionTarget(input: AWS.SecurityHub.DeleteActionTargetRequest, options: SdkCallOptions): Promise; /** * Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation. When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated. */ deleteFindingAggregator(input: AWS.SecurityHub.DeleteFindingAggregatorRequest, options: SdkCallOptions): Promise; /** * Deletes the insight specified by the InsightArn. */ deleteInsight(input: AWS.SecurityHub.DeleteInsightRequest, options: SdkCallOptions): Promise; /** * Deletes invitations received by the Amazon Web Services account to become a member account. This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations. */ deleteInvitations(input: AWS.SecurityHub.DeleteInvitationsRequest, options: SdkCallOptions): Promise; /** * Deletes the specified member accounts from Security Hub. Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually. */ deleteMembers(input: AWS.SecurityHub.DeleteMembersRequest, options: SdkCallOptions): Promise; /** * Returns a list of the custom action targets in Security Hub in your account. */ describeActionTargets(input: AWS.SecurityHub.DescribeActionTargetsRequest, options: SdkCallOptions): Promise; /** * Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub. */ describeHub(input: AWS.SecurityHub.DescribeHubRequest, options: SdkCallOptions): Promise; /** * Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account. */ describeOrganizationConfiguration(input: AWS.SecurityHub.DescribeOrganizationConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns information about product integrations in Security Hub. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you do not provide an integration ARN, then the results include all of the available product integrations. */ describeProducts(input: AWS.SecurityHub.DescribeProductsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description. */ describeStandards(input: AWS.SecurityHub.DescribeStandardsRequest, options: SdkCallOptions): Promise; /** * Returns a list of security standards controls. For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information. */ describeStandardsControls(input: AWS.SecurityHub.DescribeStandardsControlsRequest, options: SdkCallOptions): Promise; /** * Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub. */ disableImportFindingsForProduct(input: AWS.SecurityHub.DisableImportFindingsForProductRequest, options: SdkCallOptions): Promise; /** * Disables a Security Hub administrator account. Can only be called by the organization management account. */ disableOrganizationAdminAccount(input: AWS.SecurityHub.DisableOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated member accounts. When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub. */ disableSecurityHub(input: AWS.SecurityHub.DisableSecurityHubRequest, options: SdkCallOptions): Promise; /** * Disassociates the current Security Hub member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account. */ disassociateFromAdministratorAccount(input: AWS.SecurityHub.DisassociateFromAdministratorAccountRequest, options: SdkCallOptions): Promise; /** * This method is deprecated. Instead, use DisassociateFromAdministratorAccount. The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount. Disassociates the current Security Hub member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account. */ disassociateFromMasterAccount(input: AWS.SecurityHub.DisassociateFromMasterAccountRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified member accounts from the associated administrator account. Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually. */ disassociateMembers(input: AWS.SecurityHub.DisassociateMembersRequest, options: SdkCallOptions): Promise; /** * Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied. */ enableImportFindingsForProduct(input: AWS.SecurityHub.EnableImportFindingsForProductRequest, options: SdkCallOptions): Promise; /** * Designates the Security Hub administrator account for an organization. Can only be called by the organization management account. */ enableOrganizationAdminAccount(input: AWS.SecurityHub.EnableOrganizationAdminAccountRequest, options: SdkCallOptions): Promise; /** * Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub. When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards. CIS Amazon Web Services Foundations Amazon Web Services Foundational Security Best Practices You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To not enable the automatically enabled standards, set EnableDefaultStandards to false. After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation. To learn more, see the setup information in the Security Hub User Guide. */ enableSecurityHub(input: AWS.SecurityHub.EnableSecurityHubRequest, options: SdkCallOptions): Promise; /** * Provides the details for the Security Hub administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually. */ getAdministratorAccount(input: AWS.SecurityHub.GetAdministratorAccountRequest, options: SdkCallOptions): Promise; /** * Returns a list of the standards that are currently enabled. */ getEnabledStandards(input: AWS.SecurityHub.GetEnabledStandardsRequest, options: SdkCallOptions): Promise; /** * Returns the current finding aggregation configuration. */ getFindingAggregator(input: AWS.SecurityHub.GetFindingAggregatorRequest, options: SdkCallOptions): Promise; /** * Returns a list of findings that match the specified criteria. If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions. */ getFindings(input: AWS.SecurityHub.GetFindingsRequest, options: SdkCallOptions): Promise; /** * Lists the results of the Security Hub insight specified by the insight ARN. */ getInsightResults(input: AWS.SecurityHub.GetInsightResultsRequest, options: SdkCallOptions): Promise; /** * Lists and describes insights for the specified insight ARNs. */ getInsights(input: AWS.SecurityHub.GetInsightsRequest, options: SdkCallOptions): Promise; /** * Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation. */ getInvitationsCount(input: AWS.SecurityHub.GetInvitationsCountRequest, options: SdkCallOptions): Promise; /** * This method is deprecated. Instead, use GetAdministratorAccount. The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount. Provides the details for the Security Hub administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually. */ getMasterAccount(input: AWS.SecurityHub.GetMasterAccountRequest, options: SdkCallOptions): Promise; /** * Returns the details for the Security Hub member accounts for the specified account IDs. An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually. The results include both member accounts that are managed using Organizations and accounts that were invited manually. */ getMembers(input: AWS.SecurityHub.GetMembersRequest, options: SdkCallOptions): Promise; /** * Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from. This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations. Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub. When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account. */ inviteMembers(input: AWS.SecurityHub.InviteMembersRequest, options: SdkCallOptions): Promise; /** * Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub. */ listEnabledProductsForImport(input: AWS.SecurityHub.ListEnabledProductsForImportRequest, options: SdkCallOptions): Promise; /** * If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region. */ listFindingAggregators(input: AWS.SecurityHub.ListFindingAggregatorsRequest, options: SdkCallOptions): Promise; /** * Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account. This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations. */ listInvitations(input: AWS.SecurityHub.ListInvitationsRequest, options: SdkCallOptions): Promise; /** * Lists details about all member accounts for the current Security Hub administrator account. The results include both member accounts that belong to an organization and member accounts that were invited manually. */ listMembers(input: AWS.SecurityHub.ListMembersRequest, options: SdkCallOptions): Promise; /** * Lists the Security Hub administrator accounts. Can only be called by the organization management account. */ listOrganizationAdminAccounts(input: AWS.SecurityHub.ListOrganizationAdminAccountsRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags associated with a resource. */ listTagsForResource(input: AWS.SecurityHub.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to a resource. */ tagResource(input: AWS.SecurityHub.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a resource. */ untagResource(input: AWS.SecurityHub.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the name and description of a custom action target in Security Hub. */ updateActionTarget(input: AWS.SecurityHub.UpdateActionTargetRequest, options: SdkCallOptions): Promise; /** * Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region. You must run UpdateFindingAggregator from the current aggregation Region. */ updateFindingAggregator(input: AWS.SecurityHub.UpdateFindingAggregatorRequest, options: SdkCallOptions): Promise; /** * UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings. Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding. */ updateFindings(input: AWS.SecurityHub.UpdateFindingsRequest, options: SdkCallOptions): Promise; /** * Updates the Security Hub insight identified by the specified insight ARN. */ updateInsight(input: AWS.SecurityHub.UpdateInsightRequest, options: SdkCallOptions): Promise; /** * Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account. */ updateOrganizationConfiguration(input: AWS.SecurityHub.UpdateOrganizationConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates configuration options for Security Hub. */ updateSecurityHubConfiguration(input: AWS.SecurityHub.UpdateSecurityHubConfigurationRequest, options: SdkCallOptions): Promise; /** * Used to control whether an individual security standard control is enabled or disabled. */ updateStandardsControl(input: AWS.SecurityHub.UpdateStandardsControlRequest, options: SdkCallOptions): Promise; } export interface ServerlessApplicationRepository { /** * Creates an application, optionally including an AWS SAM file to create the first application version in the same call. */ createApplication(input: AWS.ServerlessApplicationRepository.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Creates an application version. */ createApplicationVersion(input: AWS.ServerlessApplicationRepository.CreateApplicationVersionRequest, options: SdkCallOptions): Promise; /** * Creates an AWS CloudFormation change set for the given application. */ createCloudFormationChangeSet(input: AWS.ServerlessApplicationRepository.CreateCloudFormationChangeSetRequest, options: SdkCallOptions): Promise; /** * Creates an AWS CloudFormation template. */ createCloudFormationTemplate(input: AWS.ServerlessApplicationRepository.CreateCloudFormationTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes the specified application. */ deleteApplication(input: AWS.ServerlessApplicationRepository.DeleteApplicationRequest, options: SdkCallOptions): Promise<{}>; /** * Gets the specified application. */ getApplication(input: AWS.ServerlessApplicationRepository.GetApplicationRequest, options: SdkCallOptions): Promise; /** * Retrieves the policy for the application. */ getApplicationPolicy(input: AWS.ServerlessApplicationRepository.GetApplicationPolicyRequest, options: SdkCallOptions): Promise; /** * Gets the specified AWS CloudFormation template. */ getCloudFormationTemplate(input: AWS.ServerlessApplicationRepository.GetCloudFormationTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves the list of applications nested in the containing application. */ listApplicationDependencies(input: AWS.ServerlessApplicationRepository.ListApplicationDependenciesRequest, options: SdkCallOptions): Promise; /** * Lists versions for the specified application. */ listApplicationVersions(input: AWS.ServerlessApplicationRepository.ListApplicationVersionsRequest, options: SdkCallOptions): Promise; /** * Lists applications owned by the requester. */ listApplications(input: AWS.ServerlessApplicationRepository.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Sets the permission policy for an application. For the list of actions supported for this operation, see Application Permissions . */ putApplicationPolicy(input: AWS.ServerlessApplicationRepository.PutApplicationPolicyRequest, options: SdkCallOptions): Promise; /** * Unshares an application from an AWS Organization.This operation can be called only from the organization's master account. */ unshareApplication(input: AWS.ServerlessApplicationRepository.UnshareApplicationRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the specified application. */ updateApplication(input: AWS.ServerlessApplicationRepository.UpdateApplicationRequest, options: SdkCallOptions): Promise; } export interface ServiceCatalog { /** * Accepts an offer to share the specified portfolio. */ acceptPortfolioShare(input: AWS.ServiceCatalog.AcceptPortfolioShareInput, options: SdkCallOptions): Promise; /** * Associates the specified budget with the specified resource. */ associateBudgetWithResource(input: AWS.ServiceCatalog.AssociateBudgetWithResourceInput, options: SdkCallOptions): Promise; /** * Associates the specified principal ARN with the specified portfolio. */ associatePrincipalWithPortfolio(input: AWS.ServiceCatalog.AssociatePrincipalWithPortfolioInput, options: SdkCallOptions): Promise; /** * Associates the specified product with the specified portfolio. A delegated admin is authorized to invoke this command. */ associateProductWithPortfolio(input: AWS.ServiceCatalog.AssociateProductWithPortfolioInput, options: SdkCallOptions): Promise; /** * Associates a self-service action with a provisioning artifact. */ associateServiceActionWithProvisioningArtifact(input: AWS.ServiceCatalog.AssociateServiceActionWithProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Associate the specified TagOption with the specified portfolio or product. */ associateTagOptionWithResource(input: AWS.ServiceCatalog.AssociateTagOptionWithResourceInput, options: SdkCallOptions): Promise; /** * Associates multiple self-service actions with provisioning artifacts. */ batchAssociateServiceActionWithProvisioningArtifact(input: AWS.ServiceCatalog.BatchAssociateServiceActionWithProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Disassociates a batch of self-service actions from the specified provisioning artifact. */ batchDisassociateServiceActionFromProvisioningArtifact(input: AWS.ServiceCatalog.BatchDisassociateServiceActionFromProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Copies the specified source product to the specified target product or a new product. You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare. This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus. */ copyProduct(input: AWS.ServiceCatalog.CopyProductInput, options: SdkCallOptions): Promise; /** * Creates a constraint. A delegated admin is authorized to invoke this command. */ createConstraint(input: AWS.ServiceCatalog.CreateConstraintInput, options: SdkCallOptions): Promise; /** * Creates a portfolio. A delegated admin is authorized to invoke this command. */ createPortfolio(input: AWS.ServiceCatalog.CreatePortfolioInput, options: SdkCallOptions): Promise; /** * Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account. Note that if a delegated admin is de-registered, they can no longer create portfolio shares. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node. You can't share a shared resource, including portfolios that contain a shared product. If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead. */ createPortfolioShare(input: AWS.ServiceCatalog.CreatePortfolioShareInput, options: SdkCallOptions): Promise; /** * Creates a product. A delegated admin is authorized to invoke this command. The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section. */ createProduct(input: AWS.ServiceCatalog.CreateProductInput, options: SdkCallOptions): Promise; /** * Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed. You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED. To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan. */ createProvisionedProductPlan(input: AWS.ServiceCatalog.CreateProvisionedProductPlanInput, options: SdkCallOptions): Promise; /** * Creates a provisioning artifact (also known as a version) for the specified product. You cannot create a provisioning artifact for a product that was shared with you. The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section. */ createProvisioningArtifact(input: AWS.ServiceCatalog.CreateProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Creates a self-service action. */ createServiceAction(input: AWS.ServiceCatalog.CreateServiceActionInput, options: SdkCallOptions): Promise; /** * Creates a TagOption. */ createTagOption(input: AWS.ServiceCatalog.CreateTagOptionInput, options: SdkCallOptions): Promise; /** * Deletes the specified constraint. A delegated admin is authorized to invoke this command. */ deleteConstraint(input: AWS.ServiceCatalog.DeleteConstraintInput, options: SdkCallOptions): Promise; /** * Deletes the specified portfolio. You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts. A delegated admin is authorized to invoke this command. */ deletePortfolio(input: AWS.ServiceCatalog.DeletePortfolioInput, options: SdkCallOptions): Promise; /** * Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator. Note that if a delegated admin is de-registered, portfolio shares created from that account are removed. */ deletePortfolioShare(input: AWS.ServiceCatalog.DeletePortfolioShareInput, options: SdkCallOptions): Promise; /** * Deletes the specified product. You cannot delete a product if it was shared with you or is associated with a portfolio. A delegated admin is authorized to invoke this command. */ deleteProduct(input: AWS.ServiceCatalog.DeleteProductInput, options: SdkCallOptions): Promise; /** * Deletes the specified plan. */ deleteProvisionedProductPlan(input: AWS.ServiceCatalog.DeleteProvisionedProductPlanInput, options: SdkCallOptions): Promise; /** * Deletes the specified provisioning artifact (also known as a version) for the specified product. You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact. */ deleteProvisioningArtifact(input: AWS.ServiceCatalog.DeleteProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Deletes a self-service action. */ deleteServiceAction(input: AWS.ServiceCatalog.DeleteServiceActionInput, options: SdkCallOptions): Promise; /** * Deletes the specified TagOption. You cannot delete a TagOption if it is associated with a product or portfolio. */ deleteTagOption(input: AWS.ServiceCatalog.DeleteTagOptionInput, options: SdkCallOptions): Promise; /** * Gets information about the specified constraint. */ describeConstraint(input: AWS.ServiceCatalog.DescribeConstraintInput, options: SdkCallOptions): Promise; /** * Gets the status of the specified copy product operation. */ describeCopyProductStatus(input: AWS.ServiceCatalog.DescribeCopyProductStatusInput, options: SdkCallOptions): Promise; /** * Gets information about the specified portfolio. A delegated admin is authorized to invoke this command. */ describePortfolio(input: AWS.ServiceCatalog.DescribePortfolioInput, options: SdkCallOptions): Promise; /** * Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin. */ describePortfolioShareStatus(input: AWS.ServiceCatalog.DescribePortfolioShareStatusInput, options: SdkCallOptions): Promise; /** * Returns a summary of each of the portfolio shares that were created for the specified portfolio. You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share. The PortfolioId and Type parameters are both required. */ describePortfolioShares(input: AWS.ServiceCatalog.DescribePortfolioSharesInput, options: SdkCallOptions): Promise; /** * Gets information about the specified product. */ describeProduct(input: AWS.ServiceCatalog.DescribeProductInput, options: SdkCallOptions): Promise; /** * Gets information about the specified product. This operation is run with administrator access. */ describeProductAsAdmin(input: AWS.ServiceCatalog.DescribeProductAsAdminInput, options: SdkCallOptions): Promise; /** * Gets information about the specified product. */ describeProductView(input: AWS.ServiceCatalog.DescribeProductViewInput, options: SdkCallOptions): Promise; /** * Gets information about the specified provisioned product. */ describeProvisionedProduct(input: AWS.ServiceCatalog.DescribeProvisionedProductInput, options: SdkCallOptions): Promise; /** * Gets information about the resource changes for the specified plan. */ describeProvisionedProductPlan(input: AWS.ServiceCatalog.DescribeProvisionedProductPlanInput, options: SdkCallOptions): Promise; /** * Gets information about the specified provisioning artifact (also known as a version) for the specified product. */ describeProvisioningArtifact(input: AWS.ServiceCatalog.DescribeProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Gets information about the configuration required to provision the specified product using the specified provisioning artifact. If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId. */ describeProvisioningParameters(input: AWS.ServiceCatalog.DescribeProvisioningParametersInput, options: SdkCallOptions): Promise; /** * Gets information about the specified request operation. Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct). If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner. */ describeRecord(input: AWS.ServiceCatalog.DescribeRecordInput, options: SdkCallOptions): Promise; /** * Describes a self-service action. */ describeServiceAction(input: AWS.ServiceCatalog.DescribeServiceActionInput, options: SdkCallOptions): Promise; /** * Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user. */ describeServiceActionExecutionParameters(input: AWS.ServiceCatalog.DescribeServiceActionExecutionParametersInput, options: SdkCallOptions): Promise; /** * Gets information about the specified TagOption. */ describeTagOption(input: AWS.ServiceCatalog.DescribeTagOptionInput, options: SdkCallOptions): Promise; /** * Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API. You cannot call this API if there are active delegated administrators in the organization. Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess. If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio. */ disableAWSOrganizationsAccess(input: AWS.ServiceCatalog.DisableAWSOrganizationsAccessInput, options: SdkCallOptions): Promise; /** * Disassociates the specified budget from the specified resource. */ disassociateBudgetFromResource(input: AWS.ServiceCatalog.DisassociateBudgetFromResourceInput, options: SdkCallOptions): Promise; /** * Disassociates a previously associated principal ARN from a specified portfolio. */ disassociatePrincipalFromPortfolio(input: AWS.ServiceCatalog.DisassociatePrincipalFromPortfolioInput, options: SdkCallOptions): Promise; /** * Disassociates the specified product from the specified portfolio. A delegated admin is authorized to invoke this command. */ disassociateProductFromPortfolio(input: AWS.ServiceCatalog.DisassociateProductFromPortfolioInput, options: SdkCallOptions): Promise; /** * Disassociates the specified self-service action association from the specified provisioning artifact. */ disassociateServiceActionFromProvisioningArtifact(input: AWS.ServiceCatalog.DisassociateServiceActionFromProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Disassociates the specified TagOption from the specified resource. */ disassociateTagOptionFromResource(input: AWS.ServiceCatalog.DisassociateTagOptionFromResourceInput, options: SdkCallOptions): Promise; /** * Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization. When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure. Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess. If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue. */ enableAWSOrganizationsAccess(input: AWS.ServiceCatalog.EnableAWSOrganizationsAccessInput, options: SdkCallOptions): Promise; /** * Provisions or modifies a product based on the resource changes for the specified plan. */ executeProvisionedProductPlan(input: AWS.ServiceCatalog.ExecuteProvisionedProductPlanInput, options: SdkCallOptions): Promise; /** * Executes a self-service action against a provisioned product. */ executeProvisionedProductServiceAction(input: AWS.ServiceCatalog.ExecuteProvisionedProductServiceActionInput, options: SdkCallOptions): Promise; /** * Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin. */ getAWSOrganizationsAccessStatus(input: AWS.ServiceCatalog.GetAWSOrganizationsAccessStatusInput, options: SdkCallOptions): Promise; /** * This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs. */ getProvisionedProductOutputs(input: AWS.ServiceCatalog.GetProvisionedProductOutputsInput, options: SdkCallOptions): Promise; /** * Requests the import of a resource as a Amazon Web Services Service Catalog provisioned product that is associated to a Amazon Web Services Service Catalog product and provisioning artifact. Once imported, all supported Amazon Web Services Service Catalog governance actions are supported on the provisioned product. Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and non-root nested stacks are not supported. The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, IMPORT_ROLLBACK_COMPLETE. Import of the resource requires that the CloudFormation stack template matches the associated Amazon Web Services Service Catalog product provisioning artifact. The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions. */ importAsProvisionedProduct(input: AWS.ServiceCatalog.ImportAsProvisionedProductInput, options: SdkCallOptions): Promise; /** * Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account. */ listAcceptedPortfolioShares(input: AWS.ServiceCatalog.ListAcceptedPortfolioSharesInput, options: SdkCallOptions): Promise; /** * Lists all the budgets associated to the specified resource. */ listBudgetsForResource(input: AWS.ServiceCatalog.ListBudgetsForResourceInput, options: SdkCallOptions): Promise; /** * Lists the constraints for the specified portfolio and product. */ listConstraintsForPortfolio(input: AWS.ServiceCatalog.ListConstraintsForPortfolioInput, options: SdkCallOptions): Promise; /** * Lists the paths to the specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product. */ listLaunchPaths(input: AWS.ServiceCatalog.ListLaunchPathsInput, options: SdkCallOptions): Promise; /** * Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin. If a delegated admin is de-registered, they can no longer perform this operation. */ listOrganizationPortfolioAccess(input: AWS.ServiceCatalog.ListOrganizationPortfolioAccessInput, options: SdkCallOptions): Promise; /** * Lists the account IDs that have access to the specified portfolio. A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation. */ listPortfolioAccess(input: AWS.ServiceCatalog.ListPortfolioAccessInput, options: SdkCallOptions): Promise; /** * Lists all portfolios in the catalog. */ listPortfolios(input: AWS.ServiceCatalog.ListPortfoliosInput, options: SdkCallOptions): Promise; /** * Lists all portfolios that the specified product is associated with. */ listPortfoliosForProduct(input: AWS.ServiceCatalog.ListPortfoliosForProductInput, options: SdkCallOptions): Promise; /** * Lists all principal ARNs associated with the specified portfolio. */ listPrincipalsForPortfolio(input: AWS.ServiceCatalog.ListPrincipalsForPortfolioInput, options: SdkCallOptions): Promise; /** * Lists the plans for the specified provisioned product or all plans to which the user has access. */ listProvisionedProductPlans(input: AWS.ServiceCatalog.ListProvisionedProductPlansInput, options: SdkCallOptions): Promise; /** * Lists all provisioning artifacts (also known as versions) for the specified product. */ listProvisioningArtifacts(input: AWS.ServiceCatalog.ListProvisioningArtifactsInput, options: SdkCallOptions): Promise; /** * Lists all provisioning artifacts (also known as versions) for the specified self-service action. */ listProvisioningArtifactsForServiceAction(input: AWS.ServiceCatalog.ListProvisioningArtifactsForServiceActionInput, options: SdkCallOptions): Promise; /** * Lists the specified requests or all performed requests. */ listRecordHistory(input: AWS.ServiceCatalog.ListRecordHistoryInput, options: SdkCallOptions): Promise; /** * Lists the resources associated with the specified TagOption. */ listResourcesForTagOption(input: AWS.ServiceCatalog.ListResourcesForTagOptionInput, options: SdkCallOptions): Promise; /** * Lists all self-service actions. */ listServiceActions(input: AWS.ServiceCatalog.ListServiceActionsInput, options: SdkCallOptions): Promise; /** * Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID. */ listServiceActionsForProvisioningArtifact(input: AWS.ServiceCatalog.ListServiceActionsForProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region. */ listStackInstancesForProvisionedProduct(input: AWS.ServiceCatalog.ListStackInstancesForProvisionedProductInput, options: SdkCallOptions): Promise; /** * Lists the specified TagOptions or all TagOptions. */ listTagOptions(input: AWS.ServiceCatalog.ListTagOptionsInput, options: SdkCallOptions): Promise; /** * Provisions the specified product. A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord. If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". */ provisionProduct(input: AWS.ServiceCatalog.ProvisionProductInput, options: SdkCallOptions): Promise; /** * Rejects an offer to share the specified portfolio. */ rejectPortfolioShare(input: AWS.ServiceCatalog.RejectPortfolioShareInput, options: SdkCallOptions): Promise; /** * Lists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts. */ scanProvisionedProducts(input: AWS.ServiceCatalog.ScanProvisionedProductsInput, options: SdkCallOptions): Promise; /** * Gets information about the products to which the caller has access. */ searchProducts(input: AWS.ServiceCatalog.SearchProductsInput, options: SdkCallOptions): Promise; /** * Gets information about the products for the specified portfolio or all products. */ searchProductsAsAdmin(input: AWS.ServiceCatalog.SearchProductsAsAdminInput, options: SdkCallOptions): Promise; /** * Gets information about the provisioned products that meet the specified criteria. To ensure a complete list of provisioned products and remove duplicate products, use sort-by createdTime. Here is a CLI example: aws servicecatalog search-provisioned-products --sort-by createdTime */ searchProvisionedProducts(input: AWS.ServiceCatalog.SearchProvisionedProductsInput, options: SdkCallOptions): Promise; /** * Terminates the specified provisioned product. This operation does not delete any records associated with the provisioned product. You can check the status of this request using DescribeRecord. */ terminateProvisionedProduct(input: AWS.ServiceCatalog.TerminateProvisionedProductInput, options: SdkCallOptions): Promise; /** * Updates the specified constraint. */ updateConstraint(input: AWS.ServiceCatalog.UpdateConstraintInput, options: SdkCallOptions): Promise; /** * Updates the specified portfolio. You cannot update a product that was shared with you. */ updatePortfolio(input: AWS.ServiceCatalog.UpdatePortfolioInput, options: SdkCallOptions): Promise; /** * Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing for an existing portfolio share. The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED. You must provide the accountId or organization node in the input, but not both. If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type. This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action. */ updatePortfolioShare(input: AWS.ServiceCatalog.UpdatePortfolioShareInput, options: SdkCallOptions): Promise; /** * Updates the specified product. */ updateProduct(input: AWS.ServiceCatalog.UpdateProductInput, options: SdkCallOptions): Promise; /** * Requests updates to the configuration of the specified provisioned product. If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely. You can check the status of this request using DescribeRecord. */ updateProvisionedProduct(input: AWS.ServiceCatalog.UpdateProvisionedProductInput, options: SdkCallOptions): Promise; /** * Requests updates to the properties of the specified provisioned product. */ updateProvisionedProductProperties(input: AWS.ServiceCatalog.UpdateProvisionedProductPropertiesInput, options: SdkCallOptions): Promise; /** * Updates the specified provisioning artifact (also known as a version) for the specified product. You cannot update a provisioning artifact for a product that was shared with you. */ updateProvisioningArtifact(input: AWS.ServiceCatalog.UpdateProvisioningArtifactInput, options: SdkCallOptions): Promise; /** * Updates a self-service action. */ updateServiceAction(input: AWS.ServiceCatalog.UpdateServiceActionInput, options: SdkCallOptions): Promise; /** * Updates the specified TagOption. */ updateTagOption(input: AWS.ServiceCatalog.UpdateTagOptionInput, options: SdkCallOptions): Promise; } export interface ServiceCatalogAppRegistry { /** * Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations. */ associateAttributeGroup(input: AWS.ServiceCatalogAppRegistry.AssociateAttributeGroupRequest, options: SdkCallOptions): Promise; /** * Associates a resource with an application. Both the resource and the application can be specified either by ID or name. */ associateResource(input: AWS.ServiceCatalogAppRegistry.AssociateResourceRequest, options: SdkCallOptions): Promise; /** * Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions. */ createApplication(input: AWS.ServiceCatalogAppRegistry.CreateApplicationRequest, options: SdkCallOptions): Promise; /** * Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools. */ createAttributeGroup(input: AWS.ServiceCatalogAppRegistry.CreateAttributeGroupRequest, options: SdkCallOptions): Promise; /** * Deletes an application that is specified either by its application ID or name. All associated attribute groups and resources must be disassociated from it before deleting an application. */ deleteApplication(input: AWS.ServiceCatalogAppRegistry.DeleteApplicationRequest, options: SdkCallOptions): Promise; /** * Deletes an attribute group, specified either by its attribute group ID or name. */ deleteAttributeGroup(input: AWS.ServiceCatalogAppRegistry.DeleteAttributeGroupRequest, options: SdkCallOptions): Promise; /** * Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts AssociateAttributeGroup. */ disassociateAttributeGroup(input: AWS.ServiceCatalogAppRegistry.DisassociateAttributeGroupRequest, options: SdkCallOptions): Promise; /** * Disassociates a resource from application. Both the resource and the application can be specified either by ID or name. */ disassociateResource(input: AWS.ServiceCatalogAppRegistry.DisassociateResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem. */ getApplication(input: AWS.ServiceCatalogAppRegistry.GetApplicationRequest, options: SdkCallOptions): Promise; /** * Gets the resource associated with the application. */ getAssociatedResource(input: AWS.ServiceCatalogAppRegistry.GetAssociatedResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves an attribute group, either by its name or its ID. The attribute group can be specified either by its unique ID or by its name. */ getAttributeGroup(input: AWS.ServiceCatalogAppRegistry.GetAttributeGroupRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all of your applications. Results are paginated. */ listApplications(input: AWS.ServiceCatalogAppRegistry.ListApplicationsRequest, options: SdkCallOptions): Promise; /** * Lists all attribute groups that are associated with specified application. Results are paginated. */ listAssociatedAttributeGroups(input: AWS.ServiceCatalogAppRegistry.ListAssociatedAttributeGroupsRequest, options: SdkCallOptions): Promise; /** * Lists all resources that are associated with specified application. Results are paginated. */ listAssociatedResources(input: AWS.ServiceCatalogAppRegistry.ListAssociatedResourcesRequest, options: SdkCallOptions): Promise; /** * Lists all attribute groups which you have access to. Results are paginated. */ listAttributeGroups(input: AWS.ServiceCatalogAppRegistry.ListAttributeGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the details of all attribute groups associated with a specific application. The results display in pages. */ listAttributeGroupsForApplication(input: AWS.ServiceCatalogAppRegistry.ListAttributeGroupsForApplicationRequest, options: SdkCallOptions): Promise; /** * Lists all of the tags on the resource. */ listTagsForResource(input: AWS.ServiceCatalogAppRegistry.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Syncs the resource with current AppRegistry records. Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource. */ syncResource(input: AWS.ServiceCatalogAppRegistry.SyncResourceRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified resource. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value. This operation returns an empty response if the call was successful. */ tagResource(input: AWS.ServiceCatalogAppRegistry.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource. This operation returns an empty response if the call was successful. */ untagResource(input: AWS.ServiceCatalogAppRegistry.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing application with new attributes. */ updateApplication(input: AWS.ServiceCatalogAppRegistry.UpdateApplicationRequest, options: SdkCallOptions): Promise; /** * Updates an existing attribute group with new details. */ updateAttributeGroup(input: AWS.ServiceCatalogAppRegistry.UpdateAttributeGroupRequest, options: SdkCallOptions): Promise; } export interface ServiceDiscovery { /** * Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS. For the current quota on the number of namespaces that you can create using the same account, see Cloud Map quotas in the Cloud Map Developer Guide. */ createHttpNamespace(input: AWS.ServiceDiscovery.CreateHttpNamespaceRequest, options: SdkCallOptions): Promise; /** * Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service is backend.example.com. Service instances that are registered using a private DNS namespace can be discovered using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same account, see Cloud Map quotas in the Cloud Map Developer Guide. */ createPrivateDnsNamespace(input: AWS.ServiceDiscovery.CreatePrivateDnsNamespaceRequest, options: SdkCallOptions): Promise; /** * Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service is backend.example.com. You can discover instances that were registered with a public DNS namespace by using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same account, see Cloud Map quotas in the Cloud Map Developer Guide. */ createPublicDnsNamespace(input: AWS.ServiceDiscovery.CreatePublicDnsNamespaceRequest, options: SdkCallOptions): Promise; /** * Creates a service. This action defines the configuration for the following entities: For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53: A AAAA A and AAAA SRV CNAME Optionally, a health check After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities. For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide. */ createService(input: AWS.ServiceDiscovery.CreateServiceRequest, options: SdkCallOptions): Promise; /** * Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails. */ deleteNamespace(input: AWS.ServiceDiscovery.DeleteNamespaceRequest, options: SdkCallOptions): Promise; /** * Deletes a specified service. If the service still contains one or more registered instances, the request fails. */ deleteService(input: AWS.ServiceDiscovery.DeleteServiceRequest, options: SdkCallOptions): Promise; /** * Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance. */ deregisterInstance(input: AWS.ServiceDiscovery.DeregisterInstanceRequest, options: SdkCallOptions): Promise; /** * Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances. */ discoverInstances(input: AWS.ServiceDiscovery.DiscoverInstancesRequest, options: SdkCallOptions): Promise; /** * Gets information about a specified instance. */ getInstance(input: AWS.ServiceDiscovery.GetInstanceRequest, options: SdkCallOptions): Promise; /** * Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service. There's a brief delay between when you register an instance and when the health status for the instance is available. */ getInstancesHealthStatus(input: AWS.ServiceDiscovery.GetInstancesHealthStatusRequest, options: SdkCallOptions): Promise; /** * Gets information about a namespace. */ getNamespace(input: AWS.ServiceDiscovery.GetNamespaceRequest, options: SdkCallOptions): Promise; /** * Gets information about any operation that returns an operation ID in the response, such as a CreateService request. To get a list of operations that match specified criteria, see ListOperations. */ getOperation(input: AWS.ServiceDiscovery.GetOperationRequest, options: SdkCallOptions): Promise; /** * Gets the settings for a specified service. */ getService(input: AWS.ServiceDiscovery.GetServiceRequest, options: SdkCallOptions): Promise; /** * Lists summary information about the instances that you registered by using a specified service. */ listInstances(input: AWS.ServiceDiscovery.ListInstancesRequest, options: SdkCallOptions): Promise; /** * Lists summary information about the namespaces that were created by the current account. */ listNamespaces(input: AWS.ServiceDiscovery.ListNamespacesRequest, options: SdkCallOptions): Promise; /** * Lists operations that match the criteria that you specify. */ listOperations(input: AWS.ServiceDiscovery.ListOperationsRequest, options: SdkCallOptions): Promise; /** * Lists summary information for all the services that are associated with one or more specified namespaces. */ listServices(input: AWS.ServiceDiscovery.ListServicesRequest, options: SdkCallOptions): Promise; /** * Lists tags for the specified resource. */ listTagsForResource(input: AWS.ServiceDiscovery.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs: For each DNS record that you define in the service that's specified by ServiceId, a record is created or updated in the hosted zone that's associated with the corresponding namespace. If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration. The health check, if any, is associated with each of the new or updated records. One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID. For more information, see CreateService. When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value: If the health check is healthy: returns all the records If the health check is unhealthy: returns the applicable value for the last healthy instance If you didn't specify a health check configuration: returns all the records For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide. */ registerInstance(input: AWS.ServiceDiscovery.RegisterInstanceRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to the specified resource. */ tagResource(input: AWS.ServiceDiscovery.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. */ untagResource(input: AWS.ServiceDiscovery.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an HTTP namespace. */ updateHttpNamespace(input: AWS.ServiceDiscovery.UpdateHttpNamespaceRequest, options: SdkCallOptions): Promise; /** * Submits a request to change the health status of a custom health check to healthy or unhealthy. You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig. For more information, see HealthCheckCustomConfig. */ updateInstanceCustomHealthStatus(input: AWS.ServiceDiscovery.UpdateInstanceCustomHealthStatusRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a private DNS namespace. */ updatePrivateDnsNamespace(input: AWS.ServiceDiscovery.UpdatePrivateDnsNamespaceRequest, options: SdkCallOptions): Promise; /** * Updates a public DNS namespace. */ updatePublicDnsNamespace(input: AWS.ServiceDiscovery.UpdatePublicDnsNamespaceRequest, options: SdkCallOptions): Promise; /** * Submits a request to perform the following operations: Update the TTL setting for existing DnsRecords configurations Add, update, or delete HealthCheckConfig for a specified service You can't add, update, or delete a HealthCheckCustomConfig configuration. For public and private DNS namespaces, note the following: If you omit any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request, the configurations are deleted from the service. If you omit an existing HealthCheckCustomConfig configuration from an UpdateService request, the configuration isn't deleted from the service. When you update settings for a service, Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service. */ updateService(input: AWS.ServiceDiscovery.UpdateServiceRequest, options: SdkCallOptions): Promise; } export interface ServiceQuotas { /** * Associates your quota request template with your organization. When a new account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template. */ associateServiceQuotaTemplate(input: AWS.ServiceQuotas.AssociateServiceQuotaTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes the quota increase request for the specified quota from your quota request template. */ deleteServiceQuotaIncreaseRequestFromTemplate(input: AWS.ServiceQuotas.DeleteServiceQuotaIncreaseRequestFromTemplateRequest, options: SdkCallOptions): Promise; /** * Disables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new accounts in your organization. Disabling a quota request template does not apply its quota increase requests. */ disassociateServiceQuotaTemplate(input: AWS.ServiceQuotas.DisassociateServiceQuotaTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves the default value for the specified quota. The default value does not reflect any quota increases. */ getAWSDefaultServiceQuota(input: AWS.ServiceQuotas.GetAWSDefaultServiceQuotaRequest, options: SdkCallOptions): Promise; /** * Retrieves the status of the association for the quota request template. */ getAssociationForServiceQuotaTemplate(input: AWS.ServiceQuotas.GetAssociationForServiceQuotaTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified quota increase request. */ getRequestedServiceQuotaChange(input: AWS.ServiceQuotas.GetRequestedServiceQuotaChangeRequest, options: SdkCallOptions): Promise; /** * Retrieves the applied quota value for the specified quota. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved. */ getServiceQuota(input: AWS.ServiceQuotas.GetServiceQuotaRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified quota increase request in your quota request template. */ getServiceQuotaIncreaseRequestFromTemplate(input: AWS.ServiceQuotas.GetServiceQuotaIncreaseRequestFromTemplateRequest, options: SdkCallOptions): Promise; /** * Lists the default values for the quotas for the specified AWS service. A default value does not reflect any quota increases. */ listAWSDefaultServiceQuotas(input: AWS.ServiceQuotas.ListAWSDefaultServiceQuotasRequest, options: SdkCallOptions): Promise; /** * Retrieves the quota increase requests for the specified service. */ listRequestedServiceQuotaChangeHistory(input: AWS.ServiceQuotas.ListRequestedServiceQuotaChangeHistoryRequest, options: SdkCallOptions): Promise; /** * Retrieves the quota increase requests for the specified quota. */ listRequestedServiceQuotaChangeHistoryByQuota(input: AWS.ServiceQuotas.ListRequestedServiceQuotaChangeHistoryByQuotaRequest, options: SdkCallOptions): Promise; /** * Lists the quota increase requests in the specified quota request template. */ listServiceQuotaIncreaseRequestsInTemplate(input: AWS.ServiceQuotas.ListServiceQuotaIncreaseRequestsInTemplateRequest, options: SdkCallOptions): Promise; /** * Lists the applied quota values for the specified AWS service. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved. */ listServiceQuotas(input: AWS.ServiceQuotas.ListServiceQuotasRequest, options: SdkCallOptions): Promise; /** * Lists the names and codes for the services integrated with Service Quotas. */ listServices(input: AWS.ServiceQuotas.ListServicesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags assigned to the specified applied quota. */ listTagsForResource(input: AWS.ServiceQuotas.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds a quota increase request to your quota request template. */ putServiceQuotaIncreaseRequestIntoTemplate(input: AWS.ServiceQuotas.PutServiceQuotaIncreaseRequestIntoTemplateRequest, options: SdkCallOptions): Promise; /** * Submits a quota increase request for the specified quota. */ requestServiceQuotaIncrease(input: AWS.ServiceQuotas.RequestServiceQuotaIncreaseRequest, options: SdkCallOptions): Promise; /** * Adds tags to the specified applied quota. You can include one or more tags to add to the quota. */ tagResource(input: AWS.ServiceQuotas.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from the specified applied quota. You can specify one or more tags to remove. */ untagResource(input: AWS.ServiceQuotas.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface SES { /** * Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. For information about setting up rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ cloneReceiptRuleSet(input: AWS.SES.CloneReceiptRuleSetRequest, options: SdkCallOptions): Promise; /** * Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createConfigurationSet(input: AWS.SES.CreateConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createConfigurationSetEventDestination(input: AWS.SES.CreateConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. */ createConfigurationSetTrackingOptions(input: AWS.SES.CreateConfigurationSetTrackingOptionsRequest, options: SdkCallOptions): Promise; /** * Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createCustomVerificationEmailTemplate(input: AWS.SES.CreateCustomVerificationEmailTemplateRequest, options: SdkCallOptions): Promise<{}>; /** * Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createReceiptFilter(input: AWS.SES.CreateReceiptFilterRequest, options: SdkCallOptions): Promise; /** * Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createReceiptRule(input: AWS.SES.CreateReceiptRuleRequest, options: SdkCallOptions): Promise; /** * Creates an empty receipt rule set. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createReceiptRuleSet(input: AWS.SES.CreateReceiptRuleSetRequest, options: SdkCallOptions): Promise; /** * Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createTemplate(input: AWS.SES.CreateTemplateRequest, options: SdkCallOptions): Promise; /** * Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteConfigurationSet(input: AWS.SES.DeleteConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteConfigurationSetEventDestination(input: AWS.SES.DeleteConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains. */ deleteConfigurationSetTrackingOptions(input: AWS.SES.DeleteConfigurationSetTrackingOptionsRequest, options: SdkCallOptions): Promise; /** * Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteCustomVerificationEmailTemplate(input: AWS.SES.DeleteCustomVerificationEmailTemplateRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second. */ deleteIdentity(input: AWS.SES.DeleteIdentityRequest, options: SdkCallOptions): Promise; /** * Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteIdentityPolicy(input: AWS.SES.DeleteIdentityPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteReceiptFilter(input: AWS.SES.DeleteReceiptFilterRequest, options: SdkCallOptions): Promise; /** * Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteReceiptRule(input: AWS.SES.DeleteReceiptRuleRequest, options: SdkCallOptions): Promise; /** * Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteReceiptRuleSet(input: AWS.SES.DeleteReceiptRuleSetRequest, options: SdkCallOptions): Promise; /** * Deletes an email template. You can execute this operation no more than once per second. */ deleteTemplate(input: AWS.SES.DeleteTemplateRequest, options: SdkCallOptions): Promise; /** * Deprecated. Use the DeleteIdentity operation to delete email addresses and domains. */ deleteVerifiedEmailAddress(input: AWS.SES.DeleteVerifiedEmailAddressRequest, options: SdkCallOptions): Promise<{}>; /** * Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ describeActiveReceiptRuleSet(input: AWS.SES.DescribeActiveReceiptRuleSetRequest, options: SdkCallOptions): Promise; /** * Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ describeConfigurationSet(input: AWS.SES.DescribeConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Returns the details of the specified receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ describeReceiptRule(input: AWS.SES.DescribeReceiptRuleRequest, options: SdkCallOptions): Promise; /** * Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ describeReceiptRuleSet(input: AWS.SES.DescribeReceiptRuleSetRequest, options: SdkCallOptions): Promise; /** * Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ getCustomVerificationEmailTemplate(input: AWS.SES.GetCustomVerificationEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. This operation takes a list of identities as input and returns the following information for each: Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address. Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses. This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. */ getIdentityDkimAttributes(input: AWS.SES.GetIdentityDkimAttributesRequest, options: SdkCallOptions): Promise; /** * Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains). This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time. */ getIdentityMailFromDomainAttributes(input: AWS.SES.GetIdentityMailFromDomainAttributesRequest, options: SdkCallOptions): Promise; /** * Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. */ getIdentityNotificationAttributes(input: AWS.SES.GetIdentityNotificationAttributesRequest, options: SdkCallOptions): Promise; /** * Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ getIdentityPolicies(input: AWS.SES.GetIdentityPoliciesRequest, options: SdkCallOptions): Promise; /** * Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning. For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning. This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. */ getIdentityVerificationAttributes(input: AWS.SES.GetIdentityVerificationAttributesRequest, options: SdkCallOptions): Promise; /** * Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second. */ getTemplate(input: AWS.SES.GetTemplateRequest, options: SdkCallOptions): Promise; /** * Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results. */ listConfigurationSets(input: AWS.SES.ListConfigurationSetsRequest, options: SdkCallOptions): Promise; /** * Lists the existing custom verification email templates for your account in the current AWS Region. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ listCustomVerificationEmailTemplates(input: AWS.SES.ListCustomVerificationEmailTemplatesRequest, options: SdkCallOptions): Promise; /** * Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status. You can execute this operation no more than once per second. */ listIdentities(input: AWS.SES.ListIdentitiesRequest, options: SdkCallOptions): Promise; /** * Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ listIdentityPolicies(input: AWS.SES.ListIdentityPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the IP address filters associated with your AWS account in the current AWS Region. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ listReceiptFilters(input: AWS.SES.ListReceiptFiltersRequest, options: SdkCallOptions): Promise; /** * Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ listReceiptRuleSets(input: AWS.SES.ListReceiptRuleSetsRequest, options: SdkCallOptions): Promise; /** * Lists the email templates present in your Amazon SES account in the current AWS Region. You can execute this operation no more than once per second. */ listTemplates(input: AWS.SES.ListTemplatesRequest, options: SdkCallOptions): Promise; /** * Adds or updates the delivery options for a configuration set. */ putConfigurationSetDeliveryOptions(input: AWS.SES.PutConfigurationSetDeliveryOptionsRequest, options: SdkCallOptions): Promise; /** * Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ putIdentityPolicy(input: AWS.SES.PutIdentityPolicyRequest, options: SdkCallOptions): Promise; /** * Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ reorderReceiptRuleSet(input: AWS.SES.ReorderReceiptRuleSetRequest, options: SdkCallOptions): Promise; /** * Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. You cannot use this API to send generic bounces for mail that was not received by Amazon SES. For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ sendBounce(input: AWS.SES.SendBounceRequest, options: SdkCallOptions): Promise; /** * Composes an email message to multiple destinations. The message body is created using an email template. In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group. The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate. */ sendBulkTemplatedEmail(input: AWS.SES.SendBulkTemplatedEmailRequest, options: SdkCallOptions): Promise; /** * Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address. To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ sendCustomVerificationEmail(input: AWS.SES.SendCustomVerificationEmailRequest, options: SdkCallOptions): Promise; /** * Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements: The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide. */ sendEmail(input: AWS.SES.SendEmailRequest, options: SdkCallOptions): Promise; /** * Composes an email message and immediately queues it for sending. This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments. The SendRawEmail operation has the following requirements: You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator. The maximum message size, including attachments, is 10 MB. Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines. If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid. Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group. Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide. Additionally, keep the following considerations in mind when using the SendRawEmail operation: Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides. If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email. If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified. For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide. */ sendRawEmail(input: AWS.SES.SendRawEmailRequest, options: SdkCallOptions): Promise; /** * Composes an email message using an email template and immediately queues it for sending. In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email. For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide. */ sendTemplatedEmail(input: AWS.SES.SendTemplatedEmailRequest, options: SdkCallOptions): Promise; /** * Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ setActiveReceiptRuleSet(input: AWS.SES.SetActiveReceiptRuleSetRequest, options: SdkCallOptions): Promise; /** * Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address. For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM. You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete. You can execute this operation no more than once per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide. */ setIdentityDkimEnabled(input: AWS.SES.SetIdentityDkimEnabledRequest, options: SdkCallOptions): Promise; /** * Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. */ setIdentityFeedbackForwardingEnabled(input: AWS.SES.SetIdentityFeedbackForwardingEnabledRequest, options: SdkCallOptions): Promise; /** * Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. */ setIdentityHeadersInNotificationsEnabled(input: AWS.SES.SetIdentityHeadersInNotificationsEnabledRequest, options: SdkCallOptions): Promise; /** * Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ setIdentityMailFromDomain(input: AWS.SES.SetIdentityMailFromDomainRequest, options: SdkCallOptions): Promise; /** * Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify. You can execute this operation no more than once per second. For more information about feedback notification, see the Amazon SES Developer Guide. */ setIdentityNotificationTopic(input: AWS.SES.SetIdentityNotificationTopicRequest, options: SdkCallOptions): Promise; /** * Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ setReceiptRulePosition(input: AWS.SES.SetReceiptRulePositionRequest, options: SdkCallOptions): Promise; /** * Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second. */ testRenderTemplate(input: AWS.SES.TestRenderTemplateRequest, options: SdkCallOptions): Promise; /** * Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds. You can execute this operation no more than once per second. */ updateAccountSendingEnabled(input: AWS.SES.UpdateAccountSendingEnabledRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). You can execute this operation no more than once per second. */ updateConfigurationSetEventDestination(input: AWS.SES.UpdateConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds. You can execute this operation no more than once per second. */ updateConfigurationSetReputationMetricsEnabled(input: AWS.SES.UpdateConfigurationSetReputationMetricsEnabledRequest, options: SdkCallOptions): Promise<{}>; /** * Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds. You can execute this operation no more than once per second. */ updateConfigurationSetSendingEnabled(input: AWS.SES.UpdateConfigurationSetSendingEnabledRequest, options: SdkCallOptions): Promise<{}>; /** * Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. */ updateConfigurationSetTrackingOptions(input: AWS.SES.UpdateConfigurationSetTrackingOptionsRequest, options: SdkCallOptions): Promise; /** * Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ updateCustomVerificationEmailTemplate(input: AWS.SES.UpdateCustomVerificationEmailTemplateRequest, options: SdkCallOptions): Promise<{}>; /** * Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ updateReceiptRule(input: AWS.SES.UpdateReceiptRuleRequest, options: SdkCallOptions): Promise; /** * Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ updateTemplate(input: AWS.SES.UpdateTemplateRequest, options: SdkCallOptions): Promise; /** * Returns a set of DKIM tokens for a domain identity. When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using the VerifyDomainIdentity operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it. You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM. To create the CNAME records for DKIM authentication, use the following values: Name: token._domainkey.example.com Type: CNAME Value: token.dkim.amazonses.com In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation. You can execute this operation no more than once per second. */ verifyDomainDkim(input: AWS.SES.VerifyDomainDkimRequest, options: SdkCallOptions): Promise; /** * Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ verifyDomainIdentity(input: AWS.SES.VerifyDomainIdentityRequest, options: SdkCallOptions): Promise; /** * Deprecated. Use the VerifyEmailIdentity operation to verify a new email address. */ verifyEmailAddress(input: AWS.SES.VerifyEmailAddressRequest, options: SdkCallOptions): Promise<{}>; /** * Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address. You can execute this operation no more than once per second. */ verifyEmailIdentity(input: AWS.SES.VerifyEmailIdentityRequest, options: SdkCallOptions): Promise; } export interface SESV2 { /** * Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. */ createConfigurationSet(input: AWS.SESV2.CreateConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination. */ createConfigurationSetEventDestination(input: AWS.SESV2.CreateConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list. */ createContact(input: AWS.SESV2.CreateContactRequest, options: SdkCallOptions): Promise; /** * Creates a contact list. */ createContactList(input: AWS.SESV2.CreateContactListRequest, options: SdkCallOptions): Promise; /** * Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createCustomVerificationEmailTemplate(input: AWS.SESV2.CreateCustomVerificationEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool. */ createDedicatedIpPool(input: AWS.SESV2.CreateDedicatedIpPoolRequest, options: SdkCallOptions): Promise; /** * Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test. */ createDeliverabilityTestReport(input: AWS.SESV2.CreateDeliverabilityTestReportRequest, options: SdkCallOptions): Promise; /** * Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity. When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM. Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key. When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process. Additionally, you can associate an existing configuration set with the email identity that you're verifying. */ createEmailIdentity(input: AWS.SESV2.CreateEmailIdentityRequest, options: SdkCallOptions): Promise; /** * Creates the specified sending authorization policy for the given identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createEmailIdentityPolicy(input: AWS.SESV2.CreateEmailIdentityPolicyRequest, options: SdkCallOptions): Promise; /** * Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ createEmailTemplate(input: AWS.SESV2.CreateEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Creates an import job for a data destination. */ createImportJob(input: AWS.SESV2.CreateImportJobRequest, options: SdkCallOptions): Promise; /** * Delete an existing configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. */ deleteConfigurationSet(input: AWS.SESV2.DeleteConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Delete an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. */ deleteConfigurationSetEventDestination(input: AWS.SESV2.DeleteConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Removes a contact from a contact list. */ deleteContact(input: AWS.SESV2.DeleteContactRequest, options: SdkCallOptions): Promise; /** * Deletes a contact list and all of the contacts on that list. */ deleteContactList(input: AWS.SESV2.DeleteContactListRequest, options: SdkCallOptions): Promise; /** * Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteCustomVerificationEmailTemplate(input: AWS.SESV2.DeleteCustomVerificationEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Delete a dedicated IP pool. */ deleteDedicatedIpPool(input: AWS.SESV2.DeleteDedicatedIpPoolRequest, options: SdkCallOptions): Promise; /** * Deletes an email identity. An identity can be either an email address or a domain name. */ deleteEmailIdentity(input: AWS.SESV2.DeleteEmailIdentityRequest, options: SdkCallOptions): Promise; /** * Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ deleteEmailIdentityPolicy(input: AWS.SESV2.DeleteEmailIdentityPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes an email template. You can execute this operation no more than once per second. */ deleteEmailTemplate(input: AWS.SESV2.DeleteEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Removes an email address from the suppression list for your account. */ deleteSuppressedDestination(input: AWS.SESV2.DeleteSuppressedDestinationRequest, options: SdkCallOptions): Promise; /** * Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region. */ getAccount(input: AWS.SESV2.GetAccountRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of the blacklists that your dedicated IP addresses appear on. */ getBlacklistReports(input: AWS.SESV2.GetBlacklistReportsRequest, options: SdkCallOptions): Promise; /** * Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. */ getConfigurationSet(input: AWS.SESV2.GetConfigurationSetRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of event destinations that are associated with a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. */ getConfigurationSetEventDestinations(input: AWS.SESV2.GetConfigurationSetEventDestinationsRequest, options: SdkCallOptions): Promise; /** * Returns a contact from a contact list. */ getContact(input: AWS.SESV2.GetContactRequest, options: SdkCallOptions): Promise; /** * Returns contact list metadata. It does not return any information about the contacts present in the list. */ getContactList(input: AWS.SESV2.GetContactListRequest, options: SdkCallOptions): Promise; /** * Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ getCustomVerificationEmailTemplate(input: AWS.SESV2.GetCustomVerificationEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address. */ getDedicatedIp(input: AWS.SESV2.GetDedicatedIpRequest, options: SdkCallOptions): Promise; /** * List the dedicated IP addresses that are associated with your Amazon Web Services account. */ getDedicatedIps(input: AWS.SESV2.GetDedicatedIpsRequest, options: SdkCallOptions): Promise; /** * Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing. */ getDeliverabilityDashboardOptions(input: AWS.SESV2.GetDeliverabilityDashboardOptionsRequest, options: SdkCallOptions): Promise; /** * Retrieve the results of a predictive inbox placement test. */ getDeliverabilityTestReport(input: AWS.SESV2.GetDeliverabilityTestReportRequest, options: SdkCallOptions): Promise; /** * Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for. */ getDomainDeliverabilityCampaign(input: AWS.SESV2.GetDomainDeliverabilityCampaignRequest, options: SdkCallOptions): Promise; /** * Retrieve inbox placement and engagement rates for the domains that you use to send email. */ getDomainStatisticsReport(input: AWS.SESV2.GetDomainStatisticsReportRequest, options: SdkCallOptions): Promise; /** * Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings. */ getEmailIdentity(input: AWS.SESV2.GetEmailIdentityRequest, options: SdkCallOptions): Promise; /** * Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ getEmailIdentityPolicies(input: AWS.SESV2.GetEmailIdentityPoliciesRequest, options: SdkCallOptions): Promise; /** * Displays the template object (which includes the subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second. */ getEmailTemplate(input: AWS.SESV2.GetEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Provides information about an import job. */ getImportJob(input: AWS.SESV2.GetImportJobRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a specific email address that's on the suppression list for your account. */ getSuppressedDestination(input: AWS.SESV2.GetSuppressedDestinationRequest, options: SdkCallOptions): Promise; /** * List all of the configuration sets associated with your account in the current region. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email. */ listConfigurationSets(input: AWS.SESV2.ListConfigurationSetsRequest, options: SdkCallOptions): Promise; /** * Lists all of the contact lists available. */ listContactLists(input: AWS.SESV2.ListContactListsRequest, options: SdkCallOptions): Promise; /** * Lists the contacts present in a specific contact list. */ listContacts(input: AWS.SESV2.ListContactsRequest, options: SdkCallOptions): Promise; /** * Lists the existing custom verification email templates for your account in the current Amazon Web Services Region. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ listCustomVerificationEmailTemplates(input: AWS.SESV2.ListCustomVerificationEmailTemplatesRequest, options: SdkCallOptions): Promise; /** * List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region. */ listDedicatedIpPools(input: AWS.SESV2.ListDedicatedIpPoolsRequest, options: SdkCallOptions): Promise; /** * Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results. */ listDeliverabilityTestReports(input: AWS.SESV2.ListDeliverabilityTestReportsRequest, options: SdkCallOptions): Promise; /** * Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain. */ listDomainDeliverabilityCampaigns(input: AWS.SESV2.ListDomainDeliverabilityCampaignsRequest, options: SdkCallOptions): Promise; /** * Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint. */ listEmailIdentities(input: AWS.SESV2.ListEmailIdentitiesRequest, options: SdkCallOptions): Promise; /** * Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region. You can execute this operation no more than once per second. */ listEmailTemplates(input: AWS.SESV2.ListEmailTemplatesRequest, options: SdkCallOptions): Promise; /** * Lists all of the import jobs. */ listImportJobs(input: AWS.SESV2.ListImportJobsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of email addresses that are on the suppression list for your account. */ listSuppressedDestinations(input: AWS.SESV2.ListSuppressedDestinationsRequest, options: SdkCallOptions): Promise; /** * Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. */ listTagsForResource(input: AWS.SESV2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Enable or disable the automatic warm-up feature for dedicated IP addresses. */ putAccountDedicatedIpWarmupAttributes(input: AWS.SESV2.PutAccountDedicatedIpWarmupAttributesRequest, options: SdkCallOptions): Promise; /** * Update your Amazon SES account details. */ putAccountDetails(input: AWS.SESV2.PutAccountDetailsRequest, options: SdkCallOptions): Promise; /** * Enable or disable the ability of your account to send email. */ putAccountSendingAttributes(input: AWS.SESV2.PutAccountSendingAttributesRequest, options: SdkCallOptions): Promise; /** * Change the settings for the account-level suppression list. */ putAccountSuppressionAttributes(input: AWS.SESV2.PutAccountSuppressionAttributesRequest, options: SdkCallOptions): Promise; /** * Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email. */ putConfigurationSetDeliveryOptions(input: AWS.SESV2.PutConfigurationSetDeliveryOptionsRequest, options: SdkCallOptions): Promise; /** * Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region. */ putConfigurationSetReputationOptions(input: AWS.SESV2.PutConfigurationSetReputationOptionsRequest, options: SdkCallOptions): Promise; /** * Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region. */ putConfigurationSetSendingOptions(input: AWS.SESV2.PutConfigurationSetSendingOptionsRequest, options: SdkCallOptions): Promise; /** * Specify the account suppression list preferences for a configuration set. */ putConfigurationSetSuppressionOptions(input: AWS.SESV2.PutConfigurationSetSuppressionOptionsRequest, options: SdkCallOptions): Promise; /** * Specify a custom domain to use for open and click tracking elements in email that you send. */ putConfigurationSetTrackingOptions(input: AWS.SESV2.PutConfigurationSetTrackingOptionsRequest, options: SdkCallOptions): Promise; /** * Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation. */ putDedicatedIpInPool(input: AWS.SESV2.PutDedicatedIpInPoolRequest, options: SdkCallOptions): Promise; putDedicatedIpWarmupAttributes(input: AWS.SESV2.PutDedicatedIpWarmupAttributesRequest, options: SdkCallOptions): Promise; /** * Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing. */ putDeliverabilityDashboardOption(input: AWS.SESV2.PutDeliverabilityDashboardOptionRequest, options: SdkCallOptions): Promise; /** * Used to associate a configuration set with an email identity. */ putEmailIdentityConfigurationSetAttributes(input: AWS.SESV2.PutEmailIdentityConfigurationSetAttributesRequest, options: SdkCallOptions): Promise; /** * Used to enable or disable DKIM authentication for an email identity. */ putEmailIdentityDkimAttributes(input: AWS.SESV2.PutEmailIdentityDkimAttributesRequest, options: SdkCallOptions): Promise; /** * Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following: Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM). Update the key length that should be used for Easy DKIM. Change from using no DKIM authentication to using Easy DKIM. Change from using no DKIM authentication to using BYODKIM. Change from using Easy DKIM to using BYODKIM. Change from using BYODKIM to using Easy DKIM. */ putEmailIdentityDkimSigningAttributes(input: AWS.SESV2.PutEmailIdentityDkimSigningAttributesRequest, options: SdkCallOptions): Promise; /** * Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled). */ putEmailIdentityFeedbackAttributes(input: AWS.SESV2.PutEmailIdentityFeedbackAttributesRequest, options: SdkCallOptions): Promise; /** * Used to enable or disable the custom Mail-From domain configuration for an email identity. */ putEmailIdentityMailFromAttributes(input: AWS.SESV2.PutEmailIdentityMailFromAttributesRequest, options: SdkCallOptions): Promise; /** * Adds an email address to the suppression list for your account. */ putSuppressedDestination(input: AWS.SESV2.PutSuppressedDestinationRequest, options: SdkCallOptions): Promise; /** * Composes an email message to multiple destinations. */ sendBulkEmail(input: AWS.SESV2.SendBulkEmailRequest, options: SdkCallOptions): Promise; /** * Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address. To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ sendCustomVerificationEmail(input: AWS.SESV2.SendCustomVerificationEmailRequest, options: SdkCallOptions): Promise; /** * Sends an email message. You can use the Amazon SES API v2 to send the following types of messages: Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you. Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message. Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify. */ sendEmail(input: AWS.SESV2.SendEmailRequest, options: SdkCallOptions): Promise; /** * Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. */ tagResource(input: AWS.SESV2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second. */ testRenderEmailTemplate(input: AWS.SESV2.TestRenderEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Remove one or more tags (keys and values) from a specified resource. */ untagResource(input: AWS.SESV2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update the configuration of an event destination for a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. */ updateConfigurationSetEventDestination(input: AWS.SESV2.UpdateConfigurationSetEventDestinationRequest, options: SdkCallOptions): Promise; /** * Updates a contact's preferences for a list. It is not necessary to specify all existing topic preferences in the TopicPreferences object, just the ones that need updating. */ updateContact(input: AWS.SESV2.UpdateContactRequest, options: SdkCallOptions): Promise; /** * Updates contact list metadata. This operation does a complete replacement. */ updateContactList(input: AWS.SESV2.UpdateContactListRequest, options: SdkCallOptions): Promise; /** * Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ updateCustomVerificationEmailTemplate(input: AWS.SESV2.UpdateCustomVerificationEmailTemplateRequest, options: SdkCallOptions): Promise; /** * Updates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ updateEmailIdentityPolicy(input: AWS.SESV2.UpdateEmailIdentityPolicyRequest, options: SdkCallOptions): Promise; /** * Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. */ updateEmailTemplate(input: AWS.SESV2.UpdateEmailTemplateRequest, options: SdkCallOptions): Promise; } export interface Shield { /** * Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription. To use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. */ associateDRTLogBucket(input: AWS.Shield.AssociateDRTLogBucketRequest, options: SdkCallOptions): Promise; /** * Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs. You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn. Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and removing IAM identity permissions. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON policy elements: Principal. The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you. You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service. To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. */ associateDRTRole(input: AWS.Shield.AssociateDRTRoleRequest, options: SdkCallOptions): Promise; /** * Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response. You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide. */ associateHealthCheck(input: AWS.Shield.AssociateHealthCheckRequest, options: SdkCallOptions): Promise; /** * Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list. After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement. This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support. The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call. */ associateProactiveEngagementDetails(input: AWS.Shield.AssociateProactiveEngagementDetailsRequest, options: SdkCallOptions): Promise; /** * Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses. You can add protection to only a single resource with each CreateProtection request. You can add protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information see Getting Started with Shield Advanced and Adding Shield Advanced protection to Amazon Web Services resources. */ createProtection(input: AWS.Shield.CreateProtectionRequest, options: SdkCallOptions): Promise; /** * Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. */ createProtectionGroup(input: AWS.Shield.CreateProtectionGroupRequest, options: SdkCallOptions): Promise; /** * Activates Shield Advanced for an account. For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed. When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. */ createSubscription(input: AWS.Shield.CreateSubscriptionRequest, options: SdkCallOptions): Promise; /** * Deletes an Shield Advanced Protection. */ deleteProtection(input: AWS.Shield.DeleteProtectionRequest, options: SdkCallOptions): Promise; /** * Removes the specified protection group. */ deleteProtectionGroup(input: AWS.Shield.DeleteProtectionGroupRequest, options: SdkCallOptions): Promise; /** * Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment. */ deleteSubscription(input: AWS.Shield.DeleteSubscriptionRequest, options: SdkCallOptions): Promise; /** * Describes the details of a DDoS attack. */ describeAttack(input: AWS.Shield.DescribeAttackRequest, options: SdkCallOptions): Promise; /** * Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers. The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC. The time range indicates the period covered by the attack statistics data items. */ describeAttackStatistics(input: AWS.Shield.DescribeAttackStatisticsRequest, options: SdkCallOptions): Promise; /** * Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation. */ describeDRTAccess(input: AWS.Shield.DescribeDRTAccessRequest, options: SdkCallOptions): Promise; /** * A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support. */ describeEmergencyContactSettings(input: AWS.Shield.DescribeEmergencyContactSettingsRequest, options: SdkCallOptions): Promise; /** * Lists the details of a Protection object. */ describeProtection(input: AWS.Shield.DescribeProtectionRequest, options: SdkCallOptions): Promise; /** * Returns the specification for the specified protection group. */ describeProtectionGroup(input: AWS.Shield.DescribeProtectionGroupRequest, options: SdkCallOptions): Promise; /** * Provides details about the Shield Advanced subscription for an account. */ describeSubscription(input: AWS.Shield.DescribeSubscriptionRequest, options: SdkCallOptions): Promise; /** * Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource. */ disableApplicationLayerAutomaticResponse(input: AWS.Shield.DisableApplicationLayerAutomaticResponseRequest, options: SdkCallOptions): Promise; /** * Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support. */ disableProactiveEngagement(input: AWS.Shield.DisableProactiveEngagementRequest, options: SdkCallOptions): Promise; /** * Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously. */ disassociateDRTLogBucket(input: AWS.Shield.DisassociateDRTLogBucketRequest, options: SdkCallOptions): Promise; /** * Removes the Shield Response Team's (SRT) access to your Amazon Web Services account. */ disassociateDRTRole(input: AWS.Shield.DisassociateDRTRoleRequest, options: SdkCallOptions): Promise; /** * Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response. You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide. */ disassociateHealthCheck(input: AWS.Shield.DisassociateHealthCheckRequest, options: SdkCallOptions): Promise; /** * Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource. This feature is available for Amazon CloudFront distributions and Application Load Balancers only. This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation. Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse. To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide. */ enableApplicationLayerAutomaticResponse(input: AWS.Shield.EnableApplicationLayerAutomaticResponseRequest, options: SdkCallOptions): Promise; /** * Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. */ enableProactiveEngagement(input: AWS.Shield.EnableProactiveEngagementRequest, options: SdkCallOptions): Promise; /** * Returns the SubscriptionState, either Active or Inactive. */ getSubscriptionState(input: AWS.Shield.GetSubscriptionStateRequest, options: SdkCallOptions): Promise; /** * Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period. */ listAttacks(input: AWS.Shield.ListAttacksRequest, options: SdkCallOptions): Promise; /** * Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria. */ listProtectionGroups(input: AWS.Shield.ListProtectionGroupsRequest, options: SdkCallOptions): Promise; /** * Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria. */ listProtections(input: AWS.Shield.ListProtectionsRequest, options: SdkCallOptions): Promise; /** * Retrieves the resources that are included in the protection group. */ listResourcesInProtectionGroup(input: AWS.Shield.ListResourcesInProtectionGroupRequest, options: SdkCallOptions): Promise; /** * Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield. */ listTagsForResource(input: AWS.Shield.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds or updates tags for a resource in Shield. */ tagResource(input: AWS.Shield.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from a resource in Shield. */ untagResource(input: AWS.Shield.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource. */ updateApplicationLayerAutomaticResponse(input: AWS.Shield.UpdateApplicationLayerAutomaticResponseRequest, options: SdkCallOptions): Promise; /** * Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support. */ updateEmergencyContactSettings(input: AWS.Shield.UpdateEmergencyContactSettingsRequest, options: SdkCallOptions): Promise; /** * Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. */ updateProtectionGroup(input: AWS.Shield.UpdateProtectionGroupRequest, options: SdkCallOptions): Promise; /** * Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated. For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed. */ updateSubscription(input: AWS.Shield.UpdateSubscriptionRequest, options: SdkCallOptions): Promise; } export interface Signer { /** * Adds cross-account permissions to a signing profile. */ addProfilePermission(input: AWS.Signer.AddProfilePermissionRequest, options: SdkCallOptions): Promise; /** * Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation. */ cancelSigningProfile(input: AWS.Signer.CancelSigningProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation. */ describeSigningJob(input: AWS.Signer.DescribeSigningJobRequest, options: SdkCallOptions): Promise; /** * Returns information on a specific signing platform. */ getSigningPlatform(input: AWS.Signer.GetSigningPlatformRequest, options: SdkCallOptions): Promise; /** * Returns information on a specific signing profile. */ getSigningProfile(input: AWS.Signer.GetSigningProfileRequest, options: SdkCallOptions): Promise; /** * Lists the cross-account permissions associated with a signing profile. */ listProfilePermissions(input: AWS.Signer.ListProfilePermissionsRequest, options: SdkCallOptions): Promise; /** * Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, code signing returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that code signing returns in the nextToken parameter until all of your signing jobs have been returned. */ listSigningJobs(input: AWS.Signer.ListSigningJobsRequest, options: SdkCallOptions): Promise; /** * Lists all signing platforms available in code signing that match the request parameters. If additional jobs remain to be listed, code signing returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that code signing returns in the nextToken parameter until all of your signing jobs have been returned. */ listSigningPlatforms(input: AWS.Signer.ListSigningPlatformsRequest, options: SdkCallOptions): Promise; /** * Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, code signing returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that code signing returns in the nextToken parameter until all of your signing jobs have been returned. */ listSigningProfiles(input: AWS.Signer.ListSigningProfilesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags associated with a signing profile resource. */ listTagsForResource(input: AWS.Signer.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Creates a signing profile. A signing profile is a code signing template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html */ putSigningProfile(input: AWS.Signer.PutSigningProfileRequest, options: SdkCallOptions): Promise; /** * Removes cross-account permissions from a signing profile. */ removeProfilePermission(input: AWS.Signer.RemoveProfilePermissionRequest, options: SdkCallOptions): Promise; /** * Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid. */ revokeSignature(input: AWS.Signer.RevokeSignatureRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid. */ revokeSigningProfile(input: AWS.Signer.RevokeSigningProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements: You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide. Your S3 source bucket must be version enabled. You must create an S3 destination bucket. Code signing uses your S3 destination bucket to write your signed code. You specify the name of the source and destination buckets when calling the StartSigningJob operation. You must also specify a request token that identifies your request to code signing. You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob. For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/ */ startSigningJob(input: AWS.Signer.StartSigningJobRequest, options: SdkCallOptions): Promise; /** * Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair. */ tagResource(input: AWS.Signer.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys. */ untagResource(input: AWS.Signer.UntagResourceRequest, options: SdkCallOptions): Promise; } export interface SimpleDB { /** * Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput. If you specify BatchDeleteAttributes without attributes or values, all the attributes for the item are deleted. BatchDeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute doesn't result in an error. The BatchDeleteAttributes operation succeeds or fails in its entirety. There are no partial deletes. You can execute multiple BatchDeleteAttributes operations and other operations in parallel. However, large numbers of concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses. This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. The following limitations are enforced for this operation: 1 MB request size 25 item limit per BatchDeleteAttributes operation */ batchDeleteAttributes(input: AWS.SimpleDB.BatchDeleteAttributesRequest, options: SdkCallOptions): Promise<{}>; /** * The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput. The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on. Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", "second_value" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same. Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute values to replace the existing attribute values. For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute with the new value. You cannot specify an empty string as an item or as an attribute name. The BatchPutAttributes operation succeeds or fails in its entirety. There are no partial puts. This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses. The following limitations are enforced for this operation: 256 attribute name-value pairs per item 1 MB request size 1 billion attributes per domain 10 GB of total user data storage per domain 25 item limit per BatchPutAttributes operation */ batchPutAttributes(input: AWS.SimpleDB.BatchPutAttributesRequest, options: SdkCallOptions): Promise<{}>; /** * The CreateDomain operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete. CreateDomain is an idempotent operation; running it multiple times using the same domain name will not result in an error response. The client can create up to 100 domains per account. If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/. */ createDomain(input: AWS.SimpleDB.CreateDomainRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted. If DeleteAttributes is called without being passed any attributes or values specified, all the attributes for the item are deleted. DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data. */ deleteAttributes(input: AWS.SimpleDB.DeleteAttributesRequest, options: SdkCallOptions): Promise<{}>; /** * The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete. Running DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response. */ deleteDomain(input: AWS.SimpleDB.DeleteDomainRequest, options: SdkCallOptions): Promise<{}>; /** * Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values. */ domainMetadata(input: AWS.SimpleDB.DomainMetadataRequest, options: SdkCallOptions): Promise; /** * Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter. If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas. If GetAttributes is called without being passed any attribute names, all the attributes for the item are returned. */ getAttributes(input: AWS.SimpleDB.GetAttributesRequest, options: SdkCallOptions): Promise; /** * The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call. */ listDomains(input: AWS.SimpleDB.ListDomainsRequest, options: SdkCallOptions): Promise; /** * The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on. Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", second_value" }. However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same. Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value. Using PutAttributes to replace attribute values that do not exist will not result in an error response. You cannot specify an empty string as an attribute name. Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data. The following limitations are enforced for this operation: 256 total attribute name-value pairs per item One billion attributes per domain 10 GB of total user data storage per domain */ putAttributes(input: AWS.SimpleDB.PutAttributesRequest, options: SdkCallOptions): Promise<{}>; /** * The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement. The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results. For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide. */ select(input: AWS.SimpleDB.SelectRequest, options: SdkCallOptions): Promise; } export interface SMS { /** * Creates an application. An application consists of one or more server groups. Each server group contain one or more servers. */ createApp(input: AWS.SMS.CreateAppRequest, options: SdkCallOptions): Promise; /** * Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI). */ createReplicationJob(input: AWS.SMS.CreateReplicationJobRequest, options: SdkCallOptions): Promise; /** * Deletes the specified application. Optionally deletes the launched stack associated with the application and all Server Migration Service replication jobs for servers in the application. */ deleteApp(input: AWS.SMS.DeleteAppRequest, options: SdkCallOptions): Promise; /** * Deletes the launch configuration for the specified application. */ deleteAppLaunchConfiguration(input: AWS.SMS.DeleteAppLaunchConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the replication configuration for the specified application. */ deleteAppReplicationConfiguration(input: AWS.SMS.DeleteAppReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the validation configuration for the specified application. */ deleteAppValidationConfiguration(input: AWS.SMS.DeleteAppValidationConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified replication job. After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created by the replication runs are not deleted. */ deleteReplicationJob(input: AWS.SMS.DeleteReplicationJobRequest, options: SdkCallOptions): Promise; /** * Deletes all servers from your server catalog. */ deleteServerCatalog(input: AWS.SMS.DeleteServerCatalogRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified connector from Server Migration Service. After you disassociate a connector, it is no longer available to support replication jobs. */ disassociateConnector(input: AWS.SMS.DisassociateConnectorRequest, options: SdkCallOptions): Promise; /** * Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket. */ generateChangeSet(input: AWS.SMS.GenerateChangeSetRequest, options: SdkCallOptions): Promise; /** * Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket. */ generateTemplate(input: AWS.SMS.GenerateTemplateRequest, options: SdkCallOptions): Promise; /** * Retrieve information about the specified application. */ getApp(input: AWS.SMS.GetAppRequest, options: SdkCallOptions): Promise; /** * Retrieves the application launch configuration associated with the specified application. */ getAppLaunchConfiguration(input: AWS.SMS.GetAppLaunchConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the application replication configuration associated with the specified application. */ getAppReplicationConfiguration(input: AWS.SMS.GetAppReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a configuration for validating an application. */ getAppValidationConfiguration(input: AWS.SMS.GetAppValidationConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves output from validating an application. */ getAppValidationOutput(input: AWS.SMS.GetAppValidationOutputRequest, options: SdkCallOptions): Promise; /** * Describes the connectors registered with the Server Migration Service. */ getConnectors(input: AWS.SMS.GetConnectorsRequest, options: SdkCallOptions): Promise; /** * Describes the specified replication job or all of your replication jobs. */ getReplicationJobs(input: AWS.SMS.GetReplicationJobsRequest, options: SdkCallOptions): Promise; /** * Describes the replication runs for the specified replication job. */ getReplicationRuns(input: AWS.SMS.GetReplicationRunsRequest, options: SdkCallOptions): Promise; /** * Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog. */ getServers(input: AWS.SMS.GetServersRequest, options: SdkCallOptions): Promise; /** * Allows application import from Migration Hub. */ importAppCatalog(input: AWS.SMS.ImportAppCatalogRequest, options: SdkCallOptions): Promise; /** * Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import. This call returns immediately, but might take additional time to retrieve all the servers. */ importServerCatalog(input: AWS.SMS.ImportServerCatalogRequest, options: SdkCallOptions): Promise; /** * Launches the specified application as a stack in CloudFormation. */ launchApp(input: AWS.SMS.LaunchAppRequest, options: SdkCallOptions): Promise; /** * Retrieves summaries for all applications. */ listApps(input: AWS.SMS.ListAppsRequest, options: SdkCallOptions): Promise; /** * Provides information to Server Migration Service about whether application validation is successful. */ notifyAppValidationOutput(input: AWS.SMS.NotifyAppValidationOutputRequest, options: SdkCallOptions): Promise; /** * Creates or updates the launch configuration for the specified application. */ putAppLaunchConfiguration(input: AWS.SMS.PutAppLaunchConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates or updates the replication configuration for the specified application. */ putAppReplicationConfiguration(input: AWS.SMS.PutAppReplicationConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates or updates a validation configuration for the specified application. */ putAppValidationConfiguration(input: AWS.SMS.PutAppValidationConfigurationRequest, options: SdkCallOptions): Promise; /** * Starts replicating the specified application by creating replication jobs for each server in the application. */ startAppReplication(input: AWS.SMS.StartAppReplicationRequest, options: SdkCallOptions): Promise; /** * Starts an on-demand replication run for the specified application. */ startOnDemandAppReplication(input: AWS.SMS.StartOnDemandAppReplicationRequest, options: SdkCallOptions): Promise; /** * Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled. There is a limit on the number of on-demand replications runs that you can request in a 24-hour period. */ startOnDemandReplicationRun(input: AWS.SMS.StartOnDemandReplicationRunRequest, options: SdkCallOptions): Promise; /** * Stops replicating the specified application by deleting the replication job for each server in the application. */ stopAppReplication(input: AWS.SMS.StopAppReplicationRequest, options: SdkCallOptions): Promise; /** * Terminates the stack for the specified application. */ terminateApp(input: AWS.SMS.TerminateAppRequest, options: SdkCallOptions): Promise; /** * Updates the specified application. */ updateApp(input: AWS.SMS.UpdateAppRequest, options: SdkCallOptions): Promise; /** * Updates the specified settings for the specified replication job. */ updateReplicationJob(input: AWS.SMS.UpdateReplicationJobRequest, options: SdkCallOptions): Promise; } export interface Snowball { /** * Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it. */ cancelCluster(input: AWS.Snowball.CancelClusterRequest, options: SdkCallOptions): Promise; /** * Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned. */ cancelJob(input: AWS.Snowball.CancelJobRequest, options: SdkCallOptions): Promise; /** * Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. */ createAddress(input: AWS.Snowball.CreateAddressRequest, options: SdkCallOptions): Promise; /** * Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created. */ createCluster(input: AWS.Snowball.CreateClusterRequest, options: SdkCallOptions): Promise; /** * Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. Only the Snowball; Edge device type is supported when ordering clustered jobs. The device capacity is optional. Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services. Snow Family devices and their capacities. Snow Family device type: SNC1_SSD Capacity: T14 Description: Snowcone Snow Family device type: SNC1_HDD Capacity: T8 Description: Snowcone Device type: EDGE_S Capacity: T98 Description: Snowball Edge Storage Optimized for data transfer only Device type: EDGE_CG Capacity: T42 Description: Snowball Edge Compute Optimized with GPU Device type: EDGE_C Capacity: T42 Description: Snowball Edge Compute Optimized without GPU Device type: EDGE Capacity: T100 Description: Snowball Edge Storage Optimized with EC2 Compute Device type: V3_5C Capacity: T32 Description: Snowball Edge Compute Optimized without GPU Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region. */ createJob(input: AWS.Snowball.CreateJobRequest, options: SdkCallOptions): Promise; /** * Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing. */ createLongTermPricing(input: AWS.Snowball.CreateLongTermPricingRequest, options: SdkCallOptions): Promise; /** * Creates a shipping label that will be used to return the Snow device to Amazon Web Services. */ createReturnShippingLabel(input: AWS.Snowball.CreateReturnShippingLabelRequest, options: SdkCallOptions): Promise; /** * Takes an AddressId and returns specific details about that address in the form of an Address object. */ describeAddress(input: AWS.Snowball.DescribeAddressRequest, options: SdkCallOptions): Promise; /** * Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions. */ describeAddresses(input: AWS.Snowball.DescribeAddressesRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific cluster including shipping information, cluster status, and other important metadata. */ describeCluster(input: AWS.Snowball.DescribeClusterRequest, options: SdkCallOptions): Promise; /** * Returns information about a specific job including shipping information, job status, and other important metadata. */ describeJob(input: AWS.Snowball.DescribeJobRequest, options: SdkCallOptions): Promise; /** * Information on the shipping label of a Snow device that is being returned to Amazon Web Services. */ describeReturnShippingLabel(input: AWS.Snowball.DescribeReturnShippingLabelRequest, options: SdkCallOptions): Promise; /** * Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created. */ getJobManifest(input: AWS.Snowball.GetJobManifestRequest, options: SdkCallOptions): Promise; /** * Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job. */ getJobUnlockCode(input: AWS.Snowball.GetJobUnlockCodeRequest, options: SdkCallOptions): Promise; /** * Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support. */ getSnowballUsage(input: AWS.Snowball.GetSnowballUsageRequest, options: SdkCallOptions): Promise; /** * Returns an Amazon S3 presigned URL for an update file associated with a specified JobId. */ getSoftwareUpdates(input: AWS.Snowball.GetSoftwareUpdatesRequest, options: SdkCallOptions): Promise; /** * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information. */ listClusterJobs(input: AWS.Snowball.ListClusterJobsRequest, options: SdkCallOptions): Promise; /** * Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. */ listClusters(input: AWS.Snowball.ListClustersRequest, options: SdkCallOptions): Promise; /** * This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the Amazon Web Services Marketplace. */ listCompatibleImages(input: AWS.Snowball.ListCompatibleImagesRequest, options: SdkCallOptions): Promise; /** * Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions. */ listJobs(input: AWS.Snowball.ListJobsRequest, options: SdkCallOptions): Promise; /** * Lists all long-term pricing types. */ listLongTermPricing(input: AWS.Snowball.ListLongTermPricingRequest, options: SdkCallOptions): Promise; /** * While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available. */ updateCluster(input: AWS.Snowball.UpdateClusterRequest, options: SdkCallOptions): Promise; /** * While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available. */ updateJob(input: AWS.Snowball.UpdateJobRequest, options: SdkCallOptions): Promise; /** * Updates the state when a shipment state changes to a different state. */ updateJobShipmentState(input: AWS.Snowball.UpdateJobShipmentStateRequest, options: SdkCallOptions): Promise; /** * Updates the long-term pricing type. */ updateLongTermPricing(input: AWS.Snowball.UpdateLongTermPricingRequest, options: SdkCallOptions): Promise; } export interface SnowDeviceManagement { /** * Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled. A task might still run if it's processed from the queue before the CancelTask operation changes the task's state. */ cancelTask(input: AWS.SnowDeviceManagement.CancelTaskInput, options: SdkCallOptions): Promise; /** * Instructs one or more devices to start a task, such as unlocking or rebooting. */ createTask(input: AWS.SnowDeviceManagement.CreateTaskInput, options: SdkCallOptions): Promise; /** * Checks device-specific information, such as the device type, software version, IP addresses, and lock status. */ describeDevice(input: AWS.SnowDeviceManagement.DescribeDeviceInput, options: SdkCallOptions): Promise; /** * Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields. */ describeDeviceEc2Instances(input: AWS.SnowDeviceManagement.DescribeDeviceEc2Input, options: SdkCallOptions): Promise; /** * Checks the status of a remote task running on one or more target devices. */ describeExecution(input: AWS.SnowDeviceManagement.DescribeExecutionInput, options: SdkCallOptions): Promise; /** * Checks the metadata for a given task on a device. */ describeTask(input: AWS.SnowDeviceManagement.DescribeTaskInput, options: SdkCallOptions): Promise; /** * Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type. */ listDeviceResources(input: AWS.SnowDeviceManagement.ListDeviceResourcesInput, options: SdkCallOptions): Promise; /** * Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run. */ listDevices(input: AWS.SnowDeviceManagement.ListDevicesInput, options: SdkCallOptions): Promise; /** * Returns the status of tasks for one or more target devices. */ listExecutions(input: AWS.SnowDeviceManagement.ListExecutionsInput, options: SdkCallOptions): Promise; /** * Returns a list of tags for a managed device or task. */ listTagsForResource(input: AWS.SnowDeviceManagement.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Returns a list of tasks that can be filtered by state. */ listTasks(input: AWS.SnowDeviceManagement.ListTasksInput, options: SdkCallOptions): Promise; /** * Adds or replaces tags on a device or task. */ tagResource(input: AWS.SnowDeviceManagement.TagResourceInput, options: SdkCallOptions): Promise<{}>; /** * Removes a tag from a device or task. */ untagResource(input: AWS.SnowDeviceManagement.UntagResourceInput, options: SdkCallOptions): Promise<{}>; } export interface SNS { /** * Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions. */ addPermission(input: AWS.SNS.AddPermissionInput, options: SdkCallOptions): Promise<{}>; /** * Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out. To resume sending messages, you can opt in the number by using the OptInPhoneNumber action. */ checkIfPhoneNumberIsOptedOut(input: AWS.SNS.CheckIfPhoneNumberIsOptedOutInput, options: SdkCallOptions): Promise; /** * Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true". */ confirmSubscription(input: AWS.SNS.ConfirmSubscriptionInput, options: SdkCallOptions): Promise; /** * Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. PlatformPrincipal and PlatformCredential are received from the notification service. For ADM, PlatformPrincipal is client id and PlatformCredential is client secret. For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key. For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key. For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key. For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key. For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key. You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action. */ createPlatformApplication(input: AWS.SNS.CreatePlatformApplicationInput, options: SdkCallOptions): Promise; /** * Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications. When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu. */ createPlatformEndpoint(input: AWS.SNS.CreatePlatformEndpointInput, options: SdkCallOptions): Promise; /** * Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. */ createSMSSandboxPhoneNumber(input: AWS.SNS.CreateSMSSandboxPhoneNumberInput, options: SdkCallOptions): Promise; /** * Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. */ createTopic(input: AWS.SNS.CreateTopicInput, options: SdkCallOptions): Promise; /** * Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications. When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic. */ deleteEndpoint(input: AWS.SNS.DeleteEndpointInput, options: SdkCallOptions): Promise<{}>; /** * Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. */ deletePlatformApplication(input: AWS.SNS.DeletePlatformApplicationInput, options: SdkCallOptions): Promise<{}>; /** * Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. */ deleteSMSSandboxPhoneNumber(input: AWS.SNS.DeleteSMSSandboxPhoneNumberInput, options: SdkCallOptions): Promise; /** * Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. */ deleteTopic(input: AWS.SNS.DeleteTopicInput, options: SdkCallOptions): Promise<{}>; /** * Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic. */ getDataProtectionPolicy(input: AWS.SNS.GetDataProtectionPolicyInput, options: SdkCallOptions): Promise; /** * Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. */ getEndpointAttributes(input: AWS.SNS.GetEndpointAttributesInput, options: SdkCallOptions): Promise; /** * Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. */ getPlatformApplicationAttributes(input: AWS.SNS.GetPlatformApplicationAttributesInput, options: SdkCallOptions): Promise; /** * Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action. */ getSMSAttributes(input: AWS.SNS.GetSMSAttributesInput, options: SdkCallOptions): Promise; /** * Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. */ getSMSSandboxAccountStatus(input: AWS.SNS.GetSMSSandboxAccountStatusInput, options: SdkCallOptions): Promise; /** * Returns all of the properties of a subscription. */ getSubscriptionAttributes(input: AWS.SNS.GetSubscriptionAttributesInput, options: SdkCallOptions): Promise; /** * Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. */ getTopicAttributes(input: AWS.SNS.GetTopicAttributesInput, options: SdkCallOptions): Promise; /** * Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 30 transactions per second (TPS). */ listEndpointsByPlatformApplication(input: AWS.SNS.ListEndpointsByPlatformApplicationInput, options: SdkCallOptions): Promise; /** * Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide. */ listOriginationNumbers(input: AWS.SNS.ListOriginationNumbersRequest, options: SdkCallOptions): Promise; /** * Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. */ listPhoneNumbersOptedOut(input: AWS.SNS.ListPhoneNumbersOptedOutInput, options: SdkCallOptions): Promise; /** * Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 15 transactions per second (TPS). */ listPlatformApplications(input: AWS.SNS.ListPlatformApplicationsInput, options: SdkCallOptions): Promise; /** * Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. */ listSMSSandboxPhoneNumbers(input: AWS.SNS.ListSMSSandboxPhoneNumbersInput, options: SdkCallOptions): Promise; /** * Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results. This action is throttled at 30 transactions per second (TPS). */ listSubscriptions(input: AWS.SNS.ListSubscriptionsInput, options: SdkCallOptions): Promise; /** * Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results. This action is throttled at 30 transactions per second (TPS). */ listSubscriptionsByTopic(input: AWS.SNS.ListSubscriptionsByTopicInput, options: SdkCallOptions): Promise; /** * List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide. */ listTagsForResource(input: AWS.SNS.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results. This action is throttled at 30 transactions per second (TPS). */ listTopics(input: AWS.SNS.ListTopicsInput, options: SdkCallOptions): Promise; /** * Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number. You can opt in a phone number only once every 30 days. */ optInPhoneNumber(input: AWS.SNS.OptInPhoneNumberInput, options: SdkCallOptions): Promise; /** * Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn). If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint. When a messageId is returned, the message is saved and Amazon SNS immediately delivers it to subscribers. To use the Publish action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. */ publish(input: AWS.SNS.PublishInput, options: SdkCallOptions): Promise; /** * Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes. The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first &AttributeName.2=second If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint. When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers. */ publishBatch(input: AWS.SNS.PublishBatchInput, options: SdkCallOptions): Promise; /** * Adds or updates an inline policy document that is stored in the specified Amazon SNS topic. */ putDataProtectionPolicy(input: AWS.SNS.PutDataProtectionPolicyInput, options: SdkCallOptions): Promise<{}>; /** * Removes a statement from a topic's access control policy. */ removePermission(input: AWS.SNS.RemovePermissionInput, options: SdkCallOptions): Promise<{}>; /** * Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. */ setEndpointAttributes(input: AWS.SNS.SetEndpointAttributesInput, options: SdkCallOptions): Promise<{}>; /** * Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status. */ setPlatformApplicationAttributes(input: AWS.SNS.SetPlatformApplicationAttributesInput, options: SdkCallOptions): Promise<{}>; /** * Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports. You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide. To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action. */ setSMSAttributes(input: AWS.SNS.SetSMSAttributesInput, options: SdkCallOptions): Promise; /** * Allows a subscription owner to set an attribute of the subscription to a new value. */ setSubscriptionAttributes(input: AWS.SNS.SetSubscriptionAttributesInput, options: SdkCallOptions): Promise<{}>; /** * Allows a topic owner to set an attribute of the topic to a new value. */ setTopicAttributes(input: AWS.SNS.SetTopicAttributesInput, options: SdkCallOptions): Promise<{}>; /** * Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription. You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days. This action is throttled at 100 transactions per second (TPS). */ subscribe(input: AWS.SNS.SubscribeInput, options: SdkCallOptions): Promise; /** * Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. When you use topic tags, keep the following guidelines in mind: Adding more than 50 tags to a topic isn't recommended. Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request. */ tagResource(input: AWS.SNS.TagResourceRequest, options: SdkCallOptions): Promise; /** * Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended. This action is throttled at 100 transactions per second (TPS). */ unsubscribe(input: AWS.SNS.UnsubscribeInput, options: SdkCallOptions): Promise<{}>; /** * Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. */ untagResource(input: AWS.SNS.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account. When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. */ verifySMSSandboxPhoneNumber(input: AWS.SNS.VerifySMSSandboxPhoneNumberInput, options: SdkCallOptions): Promise; } export interface SQS { /** * Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide. AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon SQS Developer Guide. An Amazon SQS policy can have a maximum of 7 actions. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first &AttributeName.2=second Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. */ addPermission(input: AWS.SQS.AddPermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide. For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected. An Amazon SQS message has three basic states: Sent to a queue by a producer. Received from the queue by a consumer. Deleted from the queue. A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages. Limits that apply to inflight messages are unrelated to the unlimited number of stored messages. For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. To request a limit increase, file a support request. For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages. If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time. Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received. */ changeMessageVisibility(input: AWS.SQS.ChangeMessageVisibilityRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first &AttributeName.2=second */ changeMessageVisibilityBatch(input: AWS.SQS.ChangeMessageVisibilityBatchRequest, options: SdkCallOptions): Promise; /** * Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind: If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon SQS Developer Guide. If you don't provide a value for an attribute, the queue is created with the default value for the attribute. If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues. After you create a queue, you must wait at least one second after the queue is created to be able to use the queue. To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names: If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first &AttributeName.2=second Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. */ createQueue(input: AWS.SQS.CreateQueueRequest, options: SdkCallOptions): Promise; /** * Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue. The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted). For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues. */ deleteMessage(input: AWS.SQS.DeleteMessageRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first &AttributeName.2=second */ deleteMessageBatch(input: AWS.SQS.DeleteMessageBatchRequest, options: SdkCallOptions): Promise; /** * Deletes the queue specified by the QueueUrl, regardless of the queue's contents. Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available. When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist. When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. */ deleteQueue(input: AWS.SQS.DeleteQueueRequest, options: SdkCallOptions): Promise<{}>; /** * Gets attributes for the specified queue. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix. */ getQueueAttributes(input: AWS.SQS.GetQueueAttributesRequest, options: SdkCallOptions): Promise; /** * Returns the URL of an existing Amazon SQS queue. To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide. */ getQueueUrl(input: AWS.SQS.GetQueueUrlRequest, options: SdkCallOptions): Promise; /** * Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue. The ListDeadLetterSourceQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to ListDeadLetterSourceQueues to receive the next page of results. For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide. */ listDeadLetterSourceQueues(input: AWS.SQS.ListDeadLetterSourceQueuesRequest, options: SdkCallOptions): Promise; /** * List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. */ listQueueTags(input: AWS.SQS.ListQueueTagsRequest, options: SdkCallOptions): Promise; /** * Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned. The listQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to listQueues to receive the next page of results. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. */ listQueues(input: AWS.SQS.ListQueuesRequest, options: SdkCallOptions): Promise; /** * Deletes the messages in a queue specified by the QueueURL parameter. When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue. The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size. Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute. Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged. */ purgeQueue(input: AWS.SQS.PurgeQueueRequest, options: SdkCallOptions): Promise<{}>; /** * Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide. Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request. For each message returned, the response includes the following: The message body. An MD5 digest of the message body. For information about MD5, see RFC1321. The MessageId you received when you sent the message to the queue. The receipt handle. The message attributes. An MD5 digest of the message attributes. The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide. You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide. A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. */ receiveMessage(input: AWS.SQS.ReceiveMessageRequest, options: SdkCallOptions): Promise; /** * Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of a queue can remove permissions from it. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy. */ removePermission(input: AWS.SQS.RemovePermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Delivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. */ sendMessage(input: AWS.SQS.SendMessageRequest, options: SdkCallOptions): Promise; /** * Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent. The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first &AttributeName.2=second */ sendMessageBatch(input: AWS.SQS.SendMessageBatchRequest, options: SdkCallOptions): Promise; /** * Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy. */ setQueueAttributes(input: AWS.SQS.SetQueueAttributesRequest, options: SdkCallOptions): Promise<{}>; /** * Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. When you use queue tags, keep the following guidelines in mind: Adding more than 50 tags to a queue isn't recommended. Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the existing tag. For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. */ tagQueue(input: AWS.SQS.TagQueueRequest, options: SdkCallOptions): Promise<{}>; /** * Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. */ untagQueue(input: AWS.SQS.UntagQueueRequest, options: SdkCallOptions): Promise<{}>; } export interface SSM { /** * Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example: Key=Owner,Value=DbAdmin Key=Owner,Value=SysAdmin Key=Owner,Value=Dev Key=Stack,Value=Production Key=Stack,Value=Pre-Production Key=Stack,Value=Test Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters. For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide. */ addTagsToResource(input: AWS.SSM.AddTagsToResourceRequest, options: SdkCallOptions): Promise; /** * Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager. */ associateOpsItemRelatedItem(input: AWS.SSM.AssociateOpsItemRelatedItemRequest, options: SdkCallOptions): Promise; /** * Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. */ cancelCommand(input: AWS.SSM.CancelCommandRequest, options: SdkCallOptions): Promise; /** * Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion. */ cancelMaintenanceWindowExecution(input: AWS.SSM.CancelMaintenanceWindowExecutionRequest, options: SdkCallOptions): Promise; /** * Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide. Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes. */ createActivation(input: AWS.SSM.CreateActivationRequest, options: SdkCallOptions): Promise; /** * A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. */ createAssociation(input: AWS.SSM.CreateAssociationRequest, options: SdkCallOptions): Promise; /** * Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets. When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified. If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception. */ createAssociationBatch(input: AWS.SSM.CreateAssociationBatchRequest, options: SdkCallOptions): Promise; /** * Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide. */ createDocument(input: AWS.SSM.CreateDocumentRequest, options: SdkCallOptions): Promise; /** * Creates a new maintenance window. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM. */ createMaintenanceWindow(input: AWS.SSM.CreateMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide. */ createOpsItem(input: AWS.SSM.CreateOpsItemRequest, options: SdkCallOptions): Promise; /** * If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type. */ createOpsMetadata(input: AWS.SSM.CreateOpsMetadataRequest, options: SdkCallOptions): Promise; /** * Creates a patch baseline. For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter. */ createPatchBaseline(input: AWS.SSM.CreatePatchBaselineRequest, options: SdkCallOptions): Promise; /** * A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide. You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide. A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync. By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. */ createResourceDataSync(input: AWS.SSM.CreateResourceDataSyncRequest, options: SdkCallOptions): Promise; /** * Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes. */ deleteActivation(input: AWS.SSM.DeleteActivationRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID. When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node. */ deleteAssociation(input: AWS.SSM.DeleteAssociationRequest, options: SdkCallOptions): Promise; /** * Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document. */ deleteDocument(input: AWS.SSM.DeleteDocumentRequest, options: SdkCallOptions): Promise; /** * Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema. */ deleteInventory(input: AWS.SSM.DeleteInventoryRequest, options: SdkCallOptions): Promise; /** * Deletes a maintenance window. */ deleteMaintenanceWindow(input: AWS.SSM.DeleteMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Delete OpsMetadata related to an application. */ deleteOpsMetadata(input: AWS.SSM.DeleteOpsMetadataRequest, options: SdkCallOptions): Promise; /** * Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. */ deleteParameter(input: AWS.SSM.DeleteParameterRequest, options: SdkCallOptions): Promise; /** * Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. */ deleteParameters(input: AWS.SSM.DeleteParametersRequest, options: SdkCallOptions): Promise; /** * Deletes a patch baseline. */ deletePatchBaseline(input: AWS.SSM.DeletePatchBaselineRequest, options: SdkCallOptions): Promise; /** * Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data. */ deleteResourceDataSync(input: AWS.SSM.DeleteResourceDataSyncRequest, options: SdkCallOptions): Promise; /** * Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first. */ deregisterManagedInstance(input: AWS.SSM.DeregisterManagedInstanceRequest, options: SdkCallOptions): Promise; /** * Removes a patch group from a patch baseline. */ deregisterPatchBaselineForPatchGroup(input: AWS.SSM.DeregisterPatchBaselineForPatchGroupRequest, options: SdkCallOptions): Promise; /** * Removes a target from a maintenance window. */ deregisterTargetFromMaintenanceWindow(input: AWS.SSM.DeregisterTargetFromMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Removes a task from a maintenance window. */ deregisterTaskFromMaintenanceWindow(input: AWS.SSM.DeregisterTaskFromMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation. */ describeActivations(input: AWS.SSM.DescribeActivationsRequest, options: SdkCallOptions): Promise; /** * Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. */ describeAssociation(input: AWS.SSM.DescribeAssociationRequest, options: SdkCallOptions): Promise; /** * Views information about a specific execution of a specific association. */ describeAssociationExecutionTargets(input: AWS.SSM.DescribeAssociationExecutionTargetsRequest, options: SdkCallOptions): Promise; /** * Views all executions for a specific association ID. */ describeAssociationExecutions(input: AWS.SSM.DescribeAssociationExecutionsRequest, options: SdkCallOptions): Promise; /** * Provides details about all active and terminated Automation executions. */ describeAutomationExecutions(input: AWS.SSM.DescribeAutomationExecutionsRequest, options: SdkCallOptions): Promise; /** * Information about all active and terminated step executions in an Automation workflow. */ describeAutomationStepExecutions(input: AWS.SSM.DescribeAutomationStepExecutionsRequest, options: SdkCallOptions): Promise; /** * Lists all patches eligible to be included in a patch baseline. */ describeAvailablePatches(input: AWS.SSM.DescribeAvailablePatchesRequest, options: SdkCallOptions): Promise; /** * Describes the specified Amazon Web Services Systems Manager document (SSM document). */ describeDocument(input: AWS.SSM.DescribeDocumentRequest, options: SdkCallOptions): Promise; /** * Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All). */ describeDocumentPermission(input: AWS.SSM.DescribeDocumentPermissionRequest, options: SdkCallOptions): Promise; /** * All associations for the managed node(s). */ describeEffectiveInstanceAssociations(input: AWS.SSM.DescribeEffectiveInstanceAssociationsRequest, options: SdkCallOptions): Promise; /** * Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only. */ describeEffectivePatchesForPatchBaseline(input: AWS.SSM.DescribeEffectivePatchesForPatchBaselineRequest, options: SdkCallOptions): Promise; /** * The status of the associations for the managed node(s). */ describeInstanceAssociationsStatus(input: AWS.SSM.DescribeInstanceAssociationsStatusRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your managed nodes, including information about the operating system platform, the version of SSM Agent installed on the managed node, node status, and so on. If you specify one or more managed node IDs, it returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error. The IamRole field for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This call doesn't return the IAM role for EC2 instances. */ describeInstanceInformation(input: AWS.SSM.DescribeInstanceInformationRequest, options: SdkCallOptions): Promise; /** * Retrieves the high-level patch state of one or more managed nodes. */ describeInstancePatchStates(input: AWS.SSM.DescribeInstancePatchStatesRequest, options: SdkCallOptions): Promise; /** * Retrieves the high-level patch state for the managed nodes in the specified patch group. */ describeInstancePatchStatesForPatchGroup(input: AWS.SSM.DescribeInstancePatchStatesForPatchGroupRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node. */ describeInstancePatches(input: AWS.SSM.DescribeInstancePatchesRequest, options: SdkCallOptions): Promise; /** * Describes a specific delete inventory operation. */ describeInventoryDeletions(input: AWS.SSM.DescribeInventoryDeletionsRequest, options: SdkCallOptions): Promise; /** * Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution. */ describeMaintenanceWindowExecutionTaskInvocations(input: AWS.SSM.DescribeMaintenanceWindowExecutionTaskInvocationsRequest, options: SdkCallOptions): Promise; /** * For a given maintenance window execution, lists the tasks that were run. */ describeMaintenanceWindowExecutionTasks(input: AWS.SSM.DescribeMaintenanceWindowExecutionTasksRequest, options: SdkCallOptions): Promise; /** * Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window. */ describeMaintenanceWindowExecutions(input: AWS.SSM.DescribeMaintenanceWindowExecutionsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about upcoming executions of a maintenance window. */ describeMaintenanceWindowSchedule(input: AWS.SSM.DescribeMaintenanceWindowScheduleRequest, options: SdkCallOptions): Promise; /** * Lists the targets registered with the maintenance window. */ describeMaintenanceWindowTargets(input: AWS.SSM.DescribeMaintenanceWindowTargetsRequest, options: SdkCallOptions): Promise; /** * Lists the tasks in a maintenance window. For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored. */ describeMaintenanceWindowTasks(input: AWS.SSM.DescribeMaintenanceWindowTasksRequest, options: SdkCallOptions): Promise; /** * Retrieves the maintenance windows in an Amazon Web Services account. */ describeMaintenanceWindows(input: AWS.SSM.DescribeMaintenanceWindowsRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the maintenance window targets or tasks that a managed node is associated with. */ describeMaintenanceWindowsForTarget(input: AWS.SSM.DescribeMaintenanceWindowsForTargetRequest, options: SdkCallOptions): Promise; /** * Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide. */ describeOpsItems(input: AWS.SSM.DescribeOpsItemsRequest, options: SdkCallOptions): Promise; /** * Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing. */ describeParameters(input: AWS.SSM.DescribeParametersRequest, options: SdkCallOptions): Promise; /** * Lists the patch baselines in your Amazon Web Services account. */ describePatchBaselines(input: AWS.SSM.DescribePatchBaselinesRequest, options: SdkCallOptions): Promise; /** * Returns high-level aggregated patch compliance state information for a patch group. */ describePatchGroupState(input: AWS.SSM.DescribePatchGroupStateRequest, options: SdkCallOptions): Promise; /** * Lists all patch groups that have been registered with patch baselines. */ describePatchGroups(input: AWS.SSM.DescribePatchGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines. The following section lists the properties that can be used in filters for each major operating system type: AMAZON_LINUX Valid properties: PRODUCT | CLASSIFICATION | SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT | CLASSIFICATION | SEVERITY CENTOS Valid properties: PRODUCT | CLASSIFICATION | SEVERITY DEBIAN Valid properties: PRODUCT | PRIORITY MACOS Valid properties: PRODUCT | CLASSIFICATION ORACLE_LINUX Valid properties: PRODUCT | CLASSIFICATION | SEVERITY REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT | CLASSIFICATION | SEVERITY SUSE Valid properties: PRODUCT | CLASSIFICATION | SEVERITY UBUNTU Valid properties: PRODUCT | PRIORITY WINDOWS Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY */ describePatchProperties(input: AWS.SSM.DescribePatchPropertiesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days. */ describeSessions(input: AWS.SSM.DescribeSessionsRequest, options: SdkCallOptions): Promise; /** * Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager. */ disassociateOpsItemRelatedItem(input: AWS.SSM.DisassociateOpsItemRelatedItemRequest, options: SdkCallOptions): Promise; /** * Get detailed information about a particular Automation execution. */ getAutomationExecution(input: AWS.SSM.GetAutomationExecutionRequest, options: SdkCallOptions): Promise; /** * Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED. If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED. For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide. */ getCalendarState(input: AWS.SSM.GetCalendarStateRequest, options: SdkCallOptions): Promise; /** * Returns detailed information about command execution for an invocation or plugin. GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands. */ getCommandInvocation(input: AWS.SSM.GetCommandInvocationRequest, options: SdkCallOptions): Promise; /** * Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections. */ getConnectionStatus(input: AWS.SSM.GetConnectionStatusRequest, options: SdkCallOptions): Promise; /** * Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you don't specify an operating system value, the default patch baseline for Windows is returned. */ getDefaultPatchBaseline(input: AWS.SSM.GetDefaultPatchBaselineRequest, options: SdkCallOptions): Promise; /** * Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document). If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document. */ getDeployablePatchSnapshotForInstance(input: AWS.SSM.GetDeployablePatchSnapshotForInstanceRequest, options: SdkCallOptions): Promise; /** * Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document). */ getDocument(input: AWS.SSM.GetDocumentRequest, options: SdkCallOptions): Promise; /** * Query inventory information. This includes managed node status, such as Stopped or Terminated. */ getInventory(input: AWS.SSM.GetInventoryRequest, options: SdkCallOptions): Promise; /** * Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type. */ getInventorySchema(input: AWS.SSM.GetInventorySchemaRequest, options: SdkCallOptions): Promise; /** * Retrieves a maintenance window. */ getMaintenanceWindow(input: AWS.SSM.GetMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Retrieves details about a specific a maintenance window execution. */ getMaintenanceWindowExecution(input: AWS.SSM.GetMaintenanceWindowExecutionRequest, options: SdkCallOptions): Promise; /** * Retrieves the details about a specific task run as part of a maintenance window execution. */ getMaintenanceWindowExecutionTask(input: AWS.SSM.GetMaintenanceWindowExecutionTaskRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a specific task running on a specific target. */ getMaintenanceWindowExecutionTaskInvocation(input: AWS.SSM.GetMaintenanceWindowExecutionTaskInvocationRequest, options: SdkCallOptions): Promise; /** * Retrieves the details of a maintenance window task. For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored. To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command. */ getMaintenanceWindowTask(input: AWS.SSM.GetMaintenanceWindowTaskRequest, options: SdkCallOptions): Promise; /** * Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide. */ getOpsItem(input: AWS.SSM.GetOpsItemRequest, options: SdkCallOptions): Promise; /** * View operational metadata related to an application in Application Manager. */ getOpsMetadata(input: AWS.SSM.GetOpsMetadataRequest, options: SdkCallOptions): Promise; /** * View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer. */ getOpsSummary(input: AWS.SSM.GetOpsSummaryRequest, options: SdkCallOptions): Promise; /** * Get information about a single parameter by specifying the parameter name. To get information about more than one parameter at a time, use the GetParameters operation. */ getParameter(input: AWS.SSM.GetParameterRequest, options: SdkCallOptions): Promise; /** * Retrieves the history of all changes to a parameter. If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the original key alias was referencing. */ getParameterHistory(input: AWS.SSM.GetParameterHistoryRequest, options: SdkCallOptions): Promise; /** * Get information about one or more parameters by specifying multiple parameter names. To get information about a single parameter, you can use the GetParameter operation instead. */ getParameters(input: AWS.SSM.GetParametersRequest, options: SdkCallOptions): Promise; /** * Retrieve information about one or more parameters in a specific hierarchy. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. */ getParametersByPath(input: AWS.SSM.GetParametersByPathRequest, options: SdkCallOptions): Promise; /** * Retrieves information about a patch baseline. */ getPatchBaseline(input: AWS.SSM.GetPatchBaselineRequest, options: SdkCallOptions): Promise; /** * Retrieves the patch baseline that should be used for the specified patch group. */ getPatchBaselineForPatchGroup(input: AWS.SSM.GetPatchBaselineForPatchGroupRequest, options: SdkCallOptions): Promise; /** * ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team. Query the current service setting for the Amazon Web Services account. */ getServiceSetting(input: AWS.SSM.GetServiceSettingRequest, options: SdkCallOptions): Promise; /** * A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions. A version of a parameter can have a maximum of 10 labels. You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. You can move a label from one version of a parameter to another. You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter. A label can have a maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). Labels can't begin with a number, "aws" or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels. */ labelParameterVersion(input: AWS.SSM.LabelParameterVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves all versions of an association for a specific association ID. */ listAssociationVersions(input: AWS.SSM.ListAssociationVersionsRequest, options: SdkCallOptions): Promise; /** * Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager. */ listAssociations(input: AWS.SSM.ListAssociationsRequest, options: SdkCallOptions): Promise; /** * An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution. */ listCommandInvocations(input: AWS.SSM.ListCommandInvocationsRequest, options: SdkCallOptions): Promise; /** * Lists the commands requested by users of the Amazon Web Services account. */ listCommands(input: AWS.SSM.ListCommandsRequest, options: SdkCallOptions): Promise; /** * For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter. */ listComplianceItems(input: AWS.SSM.ListComplianceItemsRequest, options: SdkCallOptions): Promise; /** * Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify. */ listComplianceSummaries(input: AWS.SSM.ListComplianceSummariesRequest, options: SdkCallOptions): Promise; /** * Information about approval reviews for a version of a change template in Change Manager. */ listDocumentMetadataHistory(input: AWS.SSM.ListDocumentMetadataHistoryRequest, options: SdkCallOptions): Promise; /** * List all versions for a document. */ listDocumentVersions(input: AWS.SSM.ListDocumentVersionsRequest, options: SdkCallOptions): Promise; /** * Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter. */ listDocuments(input: AWS.SSM.ListDocumentsRequest, options: SdkCallOptions): Promise; /** * A list of inventory items returned by the request. */ listInventoryEntries(input: AWS.SSM.ListInventoryEntriesRequest, options: SdkCallOptions): Promise; /** * Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter. */ listOpsItemEvents(input: AWS.SSM.ListOpsItemEventsRequest, options: SdkCallOptions): Promise; /** * Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager. */ listOpsItemRelatedItems(input: AWS.SSM.ListOpsItemRelatedItemsRequest, options: SdkCallOptions): Promise; /** * Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs. */ listOpsMetadata(input: AWS.SSM.ListOpsMetadataRequest, options: SdkCallOptions): Promise; /** * Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify. */ listResourceComplianceSummaries(input: AWS.SSM.ListResourceComplianceSummariesRequest, options: SdkCallOptions): Promise; /** * Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call. */ listResourceDataSync(input: AWS.SSM.ListResourceDataSyncRequest, options: SdkCallOptions): Promise; /** * Returns a list of the tags assigned to the specified resource. For information about the ID format for each supported resource type, see AddTagsToResource. */ listTagsForResource(input: AWS.SSM.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID. */ modifyDocumentPermission(input: AWS.SSM.ModifyDocumentPermissionRequest, options: SdkCallOptions): Promise; /** * Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following: ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. ExecutionType: Specify patch, association, or Custom:string. ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node. Id: The patch, association, or custom compliance ID. Title: A title. Status: The status of the compliance item. For example, approved for patches, or Failed for associations. Severity: A patch severity. For example, Critical. DocumentName: An SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document version number. For example, 4. Classification: A patch classification. For example, security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch severity. For example, Critical. PatchState: A patch state. For example, InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z' */ putComplianceItems(input: AWS.SSM.PutComplianceItemsRequest, options: SdkCallOptions): Promise; /** * Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist. */ putInventory(input: AWS.SSM.PutInventoryRequest, options: SdkCallOptions): Promise; /** * Add a parameter to the system. */ putParameter(input: AWS.SSM.PutParameterRequest, options: SdkCallOptions): Promise; /** * Defines the default patch baseline for the relevant operating system. To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed. */ registerDefaultPatchBaseline(input: AWS.SSM.RegisterDefaultPatchBaselineRequest, options: SdkCallOptions): Promise; /** * Registers a patch baseline for a patch group. */ registerPatchBaselineForPatchGroup(input: AWS.SSM.RegisterPatchBaselineForPatchGroupRequest, options: SdkCallOptions): Promise; /** * Registers a target with a maintenance window. */ registerTargetWithMaintenanceWindow(input: AWS.SSM.RegisterTargetWithMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Adds a new task to a maintenance window. */ registerTaskWithMaintenanceWindow(input: AWS.SSM.RegisterTaskWithMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Removes tag keys from the specified resource. */ removeTagsFromResource(input: AWS.SSM.RemoveTagsFromResourceRequest, options: SdkCallOptions): Promise; /** * ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting. Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team. */ resetServiceSetting(input: AWS.SSM.ResetServiceSettingRequest, options: SdkCallOptions): Promise; /** * Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use. */ resumeSession(input: AWS.SSM.ResumeSessionRequest, options: SdkCallOptions): Promise; /** * Sends a signal to an Automation execution to change the current behavior or status of the execution. */ sendAutomationSignal(input: AWS.SSM.SendAutomationSignalRequest, options: SdkCallOptions): Promise; /** * Runs commands on one or more managed nodes. */ sendCommand(input: AWS.SSM.SendCommandRequest, options: SdkCallOptions): Promise; /** * Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations. */ startAssociationsOnce(input: AWS.SSM.StartAssociationsOnceRequest, options: SdkCallOptions): Promise; /** * Initiates execution of an Automation runbook. */ startAutomationExecution(input: AWS.SSM.StartAutomationExecutionRequest, options: SdkCallOptions): Promise; /** * Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received. */ startChangeRequestExecution(input: AWS.SSM.StartChangeRequestExecutionRequest, options: SdkCallOptions): Promise; /** * Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide. Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines. */ startSession(input: AWS.SSM.StartSessionRequest, options: SdkCallOptions): Promise; /** * Stop an Automation that is currently running. */ stopAutomationExecution(input: AWS.SSM.StopAutomationExecutionRequest, options: SdkCallOptions): Promise; /** * Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed. */ terminateSession(input: AWS.SSM.TerminateSessionRequest, options: SdkCallOptions): Promise; /** * Remove a label or labels from a parameter. */ unlabelParameterVersion(input: AWS.SSM.UnlabelParameterVersionRequest, options: SdkCallOptions): Promise; /** * Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call. In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn> When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run. */ updateAssociation(input: AWS.SSM.UpdateAssociationRequest, options: SdkCallOptions): Promise; /** * Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node. UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter. */ updateAssociationStatus(input: AWS.SSM.UpdateAssociationStatusRequest, options: SdkCallOptions): Promise; /** * Updates one or more values for an SSM document. */ updateDocument(input: AWS.SSM.UpdateDocumentRequest, options: SdkCallOptions): Promise; /** * Set the default version of a document. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter. */ updateDocumentDefaultVersion(input: AWS.SSM.UpdateDocumentDefaultVersionRequest, options: SdkCallOptions): Promise; /** * Updates information related to approval reviews for a specific version of a change template in Change Manager. */ updateDocumentMetadata(input: AWS.SSM.UpdateDocumentMetadataRequest, options: SdkCallOptions): Promise; /** * Updates an existing maintenance window. Only specified parameters are modified. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM. */ updateMaintenanceWindow(input: AWS.SSM.UpdateMaintenanceWindowRequest, options: SdkCallOptions): Promise; /** * Modifies the target of an existing maintenance window. You can change the following: Name Description Owner IDs for an ID target Tags for a Tag target From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target. If a parameter is null, then the corresponding field isn't modified. */ updateMaintenanceWindowTarget(input: AWS.SSM.UpdateMaintenanceWindowTargetRequest, options: SdkCallOptions): Promise; /** * Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide. If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field isn't modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't specified are set to null. When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed. */ updateMaintenanceWindowTask(input: AWS.SSM.UpdateMaintenanceWindowTaskRequest, options: SdkCallOptions): Promise; /** * Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation. */ updateManagedInstanceRole(input: AWS.SSM.UpdateManagedInstanceRoleRequest, options: SdkCallOptions): Promise; /** * Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide. */ updateOpsItem(input: AWS.SSM.UpdateOpsItemRequest, options: SdkCallOptions): Promise; /** * Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager. */ updateOpsMetadata(input: AWS.SSM.UpdateOpsMetadataRequest, options: SdkCallOptions): Promise; /** * Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter. */ updatePatchBaseline(input: AWS.SSM.UpdatePatchBaselineRequest, options: SdkCallOptions): Promise; /** * Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one. This API operation only supports a resource data sync that was created with a SyncFromSource SyncType. */ updateResourceDataSync(input: AWS.SSM.UpdateResourceDataSyncRequest, options: SdkCallOptions): Promise; /** * ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team. Update the service setting for the account. */ updateServiceSetting(input: AWS.SSM.UpdateServiceSettingRequest, options: SdkCallOptions): Promise; } export interface SSMContacts { /** * Used to acknowledge an engagement to a contact channel during an incident. */ acceptPage(input: AWS.SSMContacts.AcceptPageRequest, options: SdkCallOptions): Promise; /** * Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated. */ activateContactChannel(input: AWS.SSMContacts.ActivateContactChannelRequest, options: SdkCallOptions): Promise; /** * Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident. */ createContact(input: AWS.SSMContacts.CreateContactRequest, options: SdkCallOptions): Promise; /** * A contact channel is the method that Incident Manager uses to engage your contact. */ createContactChannel(input: AWS.SSMContacts.CreateContactChannelRequest, options: SdkCallOptions): Promise; /** * To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel. */ deactivateContactChannel(input: AWS.SSMContacts.DeactivateContactChannelRequest, options: SdkCallOptions): Promise; /** * To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again. */ deleteContact(input: AWS.SSMContacts.DeleteContactRequest, options: SdkCallOptions): Promise; /** * To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident. */ deleteContactChannel(input: AWS.SSMContacts.DeleteContactChannelRequest, options: SdkCallOptions): Promise; /** * Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident. */ describeEngagement(input: AWS.SSMContacts.DescribeEngagementRequest, options: SdkCallOptions): Promise; /** * Lists details of the engagement to a contact channel. */ describePage(input: AWS.SSMContacts.DescribePageRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the specified contact or escalation plan. */ getContact(input: AWS.SSMContacts.GetContactRequest, options: SdkCallOptions): Promise; /** * List details about a specific contact channel. */ getContactChannel(input: AWS.SSMContacts.GetContactChannelRequest, options: SdkCallOptions): Promise; /** * Retrieves the resource policies attached to the specified contact or escalation plan. */ getContactPolicy(input: AWS.SSMContacts.GetContactPolicyRequest, options: SdkCallOptions): Promise; /** * Lists all contact channels for the specified contact. */ listContactChannels(input: AWS.SSMContacts.ListContactChannelsRequest, options: SdkCallOptions): Promise; /** * Lists all contacts and escalation plans in Incident Manager. */ listContacts(input: AWS.SSMContacts.ListContactsRequest, options: SdkCallOptions): Promise; /** * Lists all engagements that have happened in an incident. */ listEngagements(input: AWS.SSMContacts.ListEngagementsRequest, options: SdkCallOptions): Promise; /** * Lists all of the engagements to contact channels that have been acknowledged. */ listPageReceipts(input: AWS.SSMContacts.ListPageReceiptsRequest, options: SdkCallOptions): Promise; /** * Lists the engagements to a contact's contact channels. */ listPagesByContact(input: AWS.SSMContacts.ListPagesByContactRequest, options: SdkCallOptions): Promise; /** * Lists the engagements to contact channels that occurred by engaging a contact. */ listPagesByEngagement(input: AWS.SSMContacts.ListPagesByEngagementRequest, options: SdkCallOptions): Promise; /** * Lists the tags of an escalation plan or contact. */ listTagsForResource(input: AWS.SSMContacts.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality. */ putContactPolicy(input: AWS.SSMContacts.PutContactPolicyRequest, options: SdkCallOptions): Promise; /** * Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated. */ sendActivationCode(input: AWS.SSMContacts.SendActivationCodeRequest, options: SdkCallOptions): Promise; /** * Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident. */ startEngagement(input: AWS.SSMContacts.StartEngagementRequest, options: SdkCallOptions): Promise; /** * Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged. */ stopEngagement(input: AWS.SSMContacts.StopEngagementRequest, options: SdkCallOptions): Promise; /** * Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set. */ tagResource(input: AWS.SSMContacts.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from the specified resource. */ untagResource(input: AWS.SSMContacts.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the contact or escalation plan specified. */ updateContact(input: AWS.SSMContacts.UpdateContactRequest, options: SdkCallOptions): Promise; /** * Updates a contact's contact channel. */ updateContactChannel(input: AWS.SSMContacts.UpdateContactChannelRequest, options: SdkCallOptions): Promise; } export interface SSMIncidents { /** * A replication set replicates and encrypts your data to the provided Regions with the provided KMS key. */ createReplicationSet(input: AWS.SSMIncidents.CreateReplicationSetInput, options: SdkCallOptions): Promise; /** * Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident. */ createResponsePlan(input: AWS.SSMIncidents.CreateResponsePlanInput, options: SdkCallOptions): Promise; /** * Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager. */ createTimelineEvent(input: AWS.SSMIncidents.CreateTimelineEventInput, options: SdkCallOptions): Promise; /** * Delete an incident record from Incident Manager. */ deleteIncidentRecord(input: AWS.SSMIncidents.DeleteIncidentRecordInput, options: SdkCallOptions): Promise; /** * Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data. */ deleteReplicationSet(input: AWS.SSMIncidents.DeleteReplicationSetInput, options: SdkCallOptions): Promise; /** * Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource. */ deleteResourcePolicy(input: AWS.SSMIncidents.DeleteResourcePolicyInput, options: SdkCallOptions): Promise; /** * Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan. */ deleteResponsePlan(input: AWS.SSMIncidents.DeleteResponsePlanInput, options: SdkCallOptions): Promise; /** * Deletes a timeline event from an incident. */ deleteTimelineEvent(input: AWS.SSMIncidents.DeleteTimelineEventInput, options: SdkCallOptions): Promise; /** * Returns the details for the specified incident record. */ getIncidentRecord(input: AWS.SSMIncidents.GetIncidentRecordInput, options: SdkCallOptions): Promise; /** * Retrieve your Incident Manager replication set. */ getReplicationSet(input: AWS.SSMIncidents.GetReplicationSetInput, options: SdkCallOptions): Promise; /** * Retrieves the resource policies attached to the specified response plan. */ getResourcePolicies(input: AWS.SSMIncidents.GetResourcePoliciesInput, options: SdkCallOptions): Promise; /** * Retrieves the details of the specified response plan. */ getResponsePlan(input: AWS.SSMIncidents.GetResponsePlanInput, options: SdkCallOptions): Promise; /** * Retrieves a timeline event based on its ID and incident record. */ getTimelineEvent(input: AWS.SSMIncidents.GetTimelineEventInput, options: SdkCallOptions): Promise; /** * Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update. */ listIncidentRecords(input: AWS.SSMIncidents.ListIncidentRecordsInput, options: SdkCallOptions): Promise; /** * List all related items for an incident record. */ listRelatedItems(input: AWS.SSMIncidents.ListRelatedItemsInput, options: SdkCallOptions): Promise; /** * Lists details about the replication set configured in your account. */ listReplicationSets(input: AWS.SSMIncidents.ListReplicationSetsInput, options: SdkCallOptions): Promise; /** * Lists all response plans in your account. */ listResponsePlans(input: AWS.SSMIncidents.ListResponsePlansInput, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to the specified response plan. */ listTagsForResource(input: AWS.SSMIncidents.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists timeline events for the specified incident record. */ listTimelineEvents(input: AWS.SSMIncidents.ListTimelineEventsInput, options: SdkCallOptions): Promise; /** * Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality. */ putResourcePolicy(input: AWS.SSMIncidents.PutResourcePolicyInput, options: SdkCallOptions): Promise; /** * Used to start an incident from CloudWatch alarms, EventBridge events, or manually. */ startIncident(input: AWS.SSMIncidents.StartIncidentInput, options: SdkCallOptions): Promise; /** * Adds a tag to a response plan. */ tagResource(input: AWS.SSMIncidents.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes a tag from a resource. */ untagResource(input: AWS.SSMIncidents.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update deletion protection to either allow or deny deletion of the final Region in a replication set. */ updateDeletionProtection(input: AWS.SSMIncidents.UpdateDeletionProtectionInput, options: SdkCallOptions): Promise; /** * Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat. */ updateIncidentRecord(input: AWS.SSMIncidents.UpdateIncidentRecordInput, options: SdkCallOptions): Promise; /** * Add or remove related items from the related items tab of an incident record. */ updateRelatedItems(input: AWS.SSMIncidents.UpdateRelatedItemsInput, options: SdkCallOptions): Promise; /** * Add or delete Regions from your replication set. */ updateReplicationSet(input: AWS.SSMIncidents.UpdateReplicationSetInput, options: SdkCallOptions): Promise; /** * Updates the specified response plan. */ updateResponsePlan(input: AWS.SSMIncidents.UpdateResponsePlanInput, options: SdkCallOptions): Promise; /** * Updates a timeline event. You can update events of type Custom Event. */ updateTimelineEvent(input: AWS.SSMIncidents.UpdateTimelineEventInput, options: SdkCallOptions): Promise; } export interface SSO { /** * Returns the STS short-term credentials for a given role name that is assigned to the user. */ getRoleCredentials(input: AWS.SSO.GetRoleCredentialsRequest, options: SdkCallOptions): Promise; /** * Lists all roles that are assigned to the user for a given AWS account. */ listAccountRoles(input: AWS.SSO.ListAccountRolesRequest, options: SdkCallOptions): Promise; /** * Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access in the IAM Identity Center User Guide. This operation returns a paginated response. */ listAccounts(input: AWS.SSO.ListAccountsRequest, options: SdkCallOptions): Promise; /** * Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session. If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is used to obtain an IAM session, as specified in the corresponding IAM Identity Center permission set. More specifically, IAM Identity Center assumes an IAM role in the target account on behalf of the user, and the corresponding temporary AWS credentials are returned to the client. After user logout, any existing IAM role sessions that were created by using IAM Identity Center permission sets continue based on the duration configured in the permission set. For more information, see User authentications in the IAM Identity Center User Guide. */ logout(input: AWS.SSO.LogoutRequest, options: SdkCallOptions): Promise<{}>; } export interface SSOAdmin { /** * Attaches the specified customer managed policy to the specified PermissionSet. */ attachCustomerManagedPolicyReferenceToPermissionSet(input: AWS.SSOAdmin.AttachCustomerManagedPolicyReferenceToPermissionSetRequest, options: SdkCallOptions): Promise; /** * Attaches an AWS managed policy ARN to a permission set. If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this operation. Calling ProvisionPermissionSet applies the corresponding IAM policy updates to all assigned accounts. */ attachManagedPolicyToPermissionSet(input: AWS.SSOAdmin.AttachManagedPolicyToPermissionSetRequest, options: SdkCallOptions): Promise; /** * Assigns access to a principal for a specified AWS account using a specified permission set. The term principal here refers to a user or group that is defined in IAM Identity Center. As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call ProvisionPermissionSet to make these updates. After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request. */ createAccountAssignment(input: AWS.SSOAdmin.CreateAccountAssignmentRequest, options: SdkCallOptions): Promise; /** * Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide. After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that InstanceAccessControlAttributeConfiguration was created. */ createInstanceAccessControlAttributeConfiguration(input: AWS.SSOAdmin.CreateInstanceAccessControlAttributeConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a permission set within a specified IAM Identity Center instance. To grant users and groups access to AWS account resources, use CreateAccountAssignment . */ createPermissionSet(input: AWS.SSOAdmin.CreatePermissionSetRequest, options: SdkCallOptions): Promise; /** * Deletes a principal's access from a specified AWS account using a specified permission set. After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment deletion request. */ deleteAccountAssignment(input: AWS.SSOAdmin.DeleteAccountAssignmentRequest, options: SdkCallOptions): Promise; /** * Deletes the inline policy from a specified permission set. */ deleteInlinePolicyFromPermissionSet(input: AWS.SSOAdmin.DeleteInlinePolicyFromPermissionSetRequest, options: SdkCallOptions): Promise; /** * Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide. */ deleteInstanceAccessControlAttributeConfiguration(input: AWS.SSOAdmin.DeleteInstanceAccessControlAttributeConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified permission set. */ deletePermissionSet(input: AWS.SSOAdmin.DeletePermissionSetRequest, options: SdkCallOptions): Promise; /** * Deletes the permissions boundary from a specified PermissionSet. */ deletePermissionsBoundaryFromPermissionSet(input: AWS.SSOAdmin.DeletePermissionsBoundaryFromPermissionSetRequest, options: SdkCallOptions): Promise; /** * Describes the status of the assignment creation request. */ describeAccountAssignmentCreationStatus(input: AWS.SSOAdmin.DescribeAccountAssignmentCreationStatusRequest, options: SdkCallOptions): Promise; /** * Describes the status of the assignment deletion request. */ describeAccountAssignmentDeletionStatus(input: AWS.SSOAdmin.DescribeAccountAssignmentDeletionStatusRequest, options: SdkCallOptions): Promise; /** * Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide. */ describeInstanceAccessControlAttributeConfiguration(input: AWS.SSOAdmin.DescribeInstanceAccessControlAttributeConfigurationRequest, options: SdkCallOptions): Promise; /** * Gets the details of the permission set. */ describePermissionSet(input: AWS.SSOAdmin.DescribePermissionSetRequest, options: SdkCallOptions): Promise; /** * Describes the status for the given permission set provisioning request. */ describePermissionSetProvisioningStatus(input: AWS.SSOAdmin.DescribePermissionSetProvisioningStatusRequest, options: SdkCallOptions): Promise; /** * Detaches the specified customer managed policy from the specified PermissionSet. */ detachCustomerManagedPolicyReferenceFromPermissionSet(input: AWS.SSOAdmin.DetachCustomerManagedPolicyReferenceFromPermissionSetRequest, options: SdkCallOptions): Promise; /** * Detaches the attached AWS managed policy ARN from the specified permission set. */ detachManagedPolicyFromPermissionSet(input: AWS.SSOAdmin.DetachManagedPolicyFromPermissionSetRequest, options: SdkCallOptions): Promise; /** * Obtains the inline policy assigned to the permission set. */ getInlinePolicyForPermissionSet(input: AWS.SSOAdmin.GetInlinePolicyForPermissionSetRequest, options: SdkCallOptions): Promise; /** * Obtains the permissions boundary for a specified PermissionSet. */ getPermissionsBoundaryForPermissionSet(input: AWS.SSOAdmin.GetPermissionsBoundaryForPermissionSetRequest, options: SdkCallOptions): Promise; /** * Lists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance. */ listAccountAssignmentCreationStatus(input: AWS.SSOAdmin.ListAccountAssignmentCreationStatusRequest, options: SdkCallOptions): Promise; /** * Lists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance. */ listAccountAssignmentDeletionStatus(input: AWS.SSOAdmin.ListAccountAssignmentDeletionStatusRequest, options: SdkCallOptions): Promise; /** * Lists the assignee of the specified AWS account with the specified permission set. */ listAccountAssignments(input: AWS.SSOAdmin.ListAccountAssignmentsRequest, options: SdkCallOptions): Promise; /** * Lists all the AWS accounts where the specified permission set is provisioned. */ listAccountsForProvisionedPermissionSet(input: AWS.SSOAdmin.ListAccountsForProvisionedPermissionSetRequest, options: SdkCallOptions): Promise; /** * Lists all customer managed policies attached to a specified PermissionSet. */ listCustomerManagedPolicyReferencesInPermissionSet(input: AWS.SSOAdmin.ListCustomerManagedPolicyReferencesInPermissionSetRequest, options: SdkCallOptions): Promise; /** * Lists the IAM Identity Center instances that the caller has access to. */ listInstances(input: AWS.SSOAdmin.ListInstancesRequest, options: SdkCallOptions): Promise; /** * Lists the AWS managed policy that is attached to a specified permission set. */ listManagedPoliciesInPermissionSet(input: AWS.SSOAdmin.ListManagedPoliciesInPermissionSetRequest, options: SdkCallOptions): Promise; /** * Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance. */ listPermissionSetProvisioningStatus(input: AWS.SSOAdmin.ListPermissionSetProvisioningStatusRequest, options: SdkCallOptions): Promise; /** * Lists the PermissionSets in an IAM Identity Center instance. */ listPermissionSets(input: AWS.SSOAdmin.ListPermissionSetsRequest, options: SdkCallOptions): Promise; /** * Lists all the permission sets that are provisioned to a specified AWS account. */ listPermissionSetsProvisionedToAccount(input: AWS.SSOAdmin.ListPermissionSetsProvisionedToAccountRequest, options: SdkCallOptions): Promise; /** * Lists the tags that are attached to a specified resource. */ listTagsForResource(input: AWS.SSOAdmin.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * The process by which a specified permission set is provisioned to the specified target. */ provisionPermissionSet(input: AWS.SSOAdmin.ProvisionPermissionSetRequest, options: SdkCallOptions): Promise; /** * Attaches an inline policy to a permission set. If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts. */ putInlinePolicyToPermissionSet(input: AWS.SSOAdmin.PutInlinePolicyToPermissionSetRequest, options: SdkCallOptions): Promise; /** * Attaches an AWS managed or customer managed policy to the specified PermissionSet as a permissions boundary. */ putPermissionsBoundaryToPermissionSet(input: AWS.SSOAdmin.PutPermissionsBoundaryToPermissionSetRequest, options: SdkCallOptions): Promise; /** * Associates a set of tags with a specified resource. */ tagResource(input: AWS.SSOAdmin.TagResourceRequest, options: SdkCallOptions): Promise; /** * Disassociates a set of tags from a specified resource. */ untagResource(input: AWS.SSOAdmin.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide. */ updateInstanceAccessControlAttributeConfiguration(input: AWS.SSOAdmin.UpdateInstanceAccessControlAttributeConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates an existing permission set. */ updatePermissionSet(input: AWS.SSOAdmin.UpdatePermissionSetRequest, options: SdkCallOptions): Promise; } export interface SSOOIDC { /** * Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account. */ createToken(input: AWS.SSOOIDC.CreateTokenRequest, options: SdkCallOptions): Promise; /** * Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests. */ registerClient(input: AWS.SSOOIDC.RegisterClientRequest, options: SdkCallOptions): Promise; /** * Initiates device authorization by requesting a pair of verification codes from the authorization service. */ startDeviceAuthorization(input: AWS.SSOOIDC.StartDeviceAuthorizationRequest, options: SdkCallOptions): Promise; } export interface StepFunctions { /** * Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different. */ createActivity(input: AWS.StepFunctions.CreateActivityInput, options: SdkCallOptions): Promise; /** * Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the AWS Step Functions User Guide. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different. */ createStateMachine(input: AWS.StepFunctions.CreateStateMachineInput, options: SdkCallOptions): Promise; /** * Deletes an activity. */ deleteActivity(input: AWS.StepFunctions.DeleteActivityInput, options: SdkCallOptions): Promise; /** * Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called. */ deleteStateMachine(input: AWS.StepFunctions.DeleteStateMachineInput, options: SdkCallOptions): Promise; /** * Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeActivity(input: AWS.StepFunctions.DescribeActivityInput, options: SdkCallOptions): Promise; /** * Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines. */ describeExecution(input: AWS.StepFunctions.DescribeExecutionInput, options: SdkCallOptions): Promise; /** * Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ describeStateMachine(input: AWS.StepFunctions.DescribeStateMachineInput, options: SdkCallOptions): Promise; /** * Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines. */ describeStateMachineForExecution(input: AWS.StepFunctions.DescribeStateMachineForExecutionInput, options: SdkCallOptions): Promise; /** * Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide. */ getActivityTask(input: AWS.StepFunctions.GetActivityTaskInput, options: SdkCallOptions): Promise; /** * Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This API action is not supported by EXPRESS state machines. */ getExecutionHistory(input: AWS.StepFunctions.GetExecutionHistoryInput, options: SdkCallOptions): Promise; /** * Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ listActivities(input: AWS.StepFunctions.ListActivitiesInput, options: SdkCallOptions): Promise; /** * Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines. */ listExecutions(input: AWS.StepFunctions.ListExecutionsInput, options: SdkCallOptions): Promise; /** * Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. */ listStateMachines(input: AWS.StepFunctions.ListStateMachinesInput, options: SdkCallOptions): Promise; /** * List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. */ listTagsForResource(input: AWS.StepFunctions.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed. */ sendTaskFailure(input: AWS.StepFunctions.SendTaskFailureInput, options: SdkCallOptions): Promise; /** * Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats. */ sendTaskHeartbeat(input: AWS.StepFunctions.SendTaskHeartbeatInput, options: SdkCallOptions): Promise; /** * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully. */ sendTaskSuccess(input: AWS.StepFunctions.SendTaskSuccessInput, options: SdkCallOptions): Promise; /** * Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days. */ startExecution(input: AWS.StepFunctions.StartExecutionInput, options: SdkCallOptions): Promise; /** * Starts a Synchronous Express state machine execution. */ startSyncExecution(input: AWS.StepFunctions.StartSyncExecutionInput, options: SdkCallOptions): Promise; /** * Stops an execution. This API action is not supported by EXPRESS state machines. */ stopExecution(input: AWS.StepFunctions.StopExecutionInput, options: SdkCallOptions): Promise; /** * Add a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @. */ tagResource(input: AWS.StepFunctions.TagResourceInput, options: SdkCallOptions): Promise; /** * Remove a tag from a Step Functions resource */ untagResource(input: AWS.StepFunctions.UntagResourceInput, options: SdkCallOptions): Promise; /** * Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn. */ updateStateMachine(input: AWS.StepFunctions.UpdateStateMachineInput, options: SdkCallOptions): Promise; } export interface StorageGateway { /** * Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation. You must turn on the gateway VM before you can activate your gateway. */ activateGateway(input: AWS.StorageGateway.ActivateGatewayInput, options: SdkCallOptions): Promise; /** * Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache. */ addCache(input: AWS.StorageGateway.AddCacheInput, options: SdkCallOptions): Promise; /** * Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following Storage Gateway resources: Storage gateways of all types Storage volumes Virtual tapes NFS and SMB file shares File System associations You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. */ addTagsToResource(input: AWS.StorageGateway.AddTagsToResourceInput, options: SdkCallOptions): Promise; /** * Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. */ addUploadBuffer(input: AWS.StorageGateway.AddUploadBufferInput, options: SdkCallOptions): Promise; /** * Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. */ addWorkingStorage(input: AWS.StorageGateway.AddWorkingStorageInput, options: SdkCallOptions): Promise; /** * Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool. */ assignTapePool(input: AWS.StorageGateway.AssignTapePoolInput, options: SdkCallOptions): Promise; /** * Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type. */ associateFileSystem(input: AWS.StorageGateway.AssociateFileSystemInput, options: SdkCallOptions): Promise; /** * Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. */ attachVolume(input: AWS.StorageGateway.AttachVolumeInput, options: SdkCallOptions): Promise; /** * Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type. */ cancelArchival(input: AWS.StorageGateway.CancelArchivalInput, options: SdkCallOptions): Promise; /** * Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type. */ cancelRetrieval(input: AWS.StorageGateway.CancelRetrievalInput, options: SdkCallOptions): Promise; /** * Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes. */ createCachediSCSIVolume(input: AWS.StorageGateway.CreateCachediSCSIVolumeInput, options: SdkCallOptions): Promise; /** * Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for S3 File Gateways. S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide. S3 File Gateways do not support creating hard or symbolic links on a file share. */ createNFSFileShare(input: AWS.StorageGateway.CreateNFSFileShareInput, options: SdkCallOptions): Promise; /** * Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways. S3 File Gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share. */ createSMBFileShare(input: AWS.StorageGateway.CreateSMBFileShareInput, options: SdkCallOptions): Promise; /** * Initiates a snapshot of a volume. Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a snapshot schedule. In the CreateSnapshot request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the Storage Gateway console. In response, Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference. Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page. */ createSnapshot(input: AWS.StorageGateway.CreateSnapshotInput, options: SdkCallOptions): Promise; /** * Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference. */ createSnapshotFromVolumeRecoveryPoint(input: AWS.StorageGateway.CreateSnapshotFromVolumeRecoveryPointInput, options: SdkCallOptions): Promise; /** * Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. */ createStorediSCSIVolume(input: AWS.StorageGateway.CreateStorediSCSIVolumeInput, options: SdkCallOptions): Promise; /** * Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool. */ createTapePool(input: AWS.StorageGateway.CreateTapePoolInput, options: SdkCallOptions): Promise; /** * Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway. */ createTapeWithBarcode(input: AWS.StorageGateway.CreateTapeWithBarcodeInput, options: SdkCallOptions): Promise; /** * Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway. */ createTapes(input: AWS.StorageGateway.CreateTapesInput, options: SdkCallOptions): Promise; /** * Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy. */ deleteAutomaticTapeCreationPolicy(input: AWS.StorageGateway.DeleteAutomaticTapeCreationPolicyInput, options: SdkCallOptions): Promise; /** * Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types. */ deleteBandwidthRateLimit(input: AWS.StorageGateway.DeleteBandwidthRateLimitInput, options: SdkCallOptions): Promise; /** * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types. */ deleteChapCredentials(input: AWS.StorageGateway.DeleteChapCredentialsInput, options: SdkCallOptions): Promise; /** * Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways. */ deleteFileShare(input: AWS.StorageGateway.DeleteFileShareInput, options: SdkCallOptions): Promise; /** * Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the Storage Gateway detail page. */ deleteGateway(input: AWS.StorageGateway.DeleteGatewayInput, options: SdkCallOptions): Promise; /** * Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. */ deleteSnapshotSchedule(input: AWS.StorageGateway.DeleteSnapshotScheduleInput, options: SdkCallOptions): Promise; /** * Deletes the specified virtual tape. This operation is only supported in the tape gateway type. */ deleteTape(input: AWS.StorageGateway.DeleteTapeInput, options: SdkCallOptions): Promise; /** * Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. */ deleteTapeArchive(input: AWS.StorageGateway.DeleteTapeArchiveInput, options: SdkCallOptions): Promise; /** * Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool. */ deleteTapePool(input: AWS.StorageGateway.DeleteTapePoolInput, options: SdkCallOptions): Promise; /** * Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. */ deleteVolume(input: AWS.StorageGateway.DeleteVolumeInput, options: SdkCallOptions): Promise; /** * Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null. */ describeAvailabilityMonitorTest(input: AWS.StorageGateway.DescribeAvailabilityMonitorTestInput, options: SdkCallOptions): Promise; /** * Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule. This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. */ describeBandwidthRateLimit(input: AWS.StorageGateway.DescribeBandwidthRateLimitInput, options: SdkCallOptions): Promise; /** * Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits. This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both. A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. */ describeBandwidthRateLimitSchedule(input: AWS.StorageGateway.DescribeBandwidthRateLimitScheduleInput, options: SdkCallOptions): Promise; /** * Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. */ describeCache(input: AWS.StorageGateway.DescribeCacheInput, options: SdkCallOptions): Promise; /** * Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). */ describeCachediSCSIVolumes(input: AWS.StorageGateway.DescribeCachediSCSIVolumesInput, options: SdkCallOptions): Promise; /** * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types. */ describeChapCredentials(input: AWS.StorageGateway.DescribeChapCredentialsInput, options: SdkCallOptions): Promise; /** * Gets the file system association information. This operation is only supported for FSx File Gateways. */ describeFileSystemAssociations(input: AWS.StorageGateway.DescribeFileSystemAssociationsInput, options: SdkCallOptions): Promise; /** * Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. */ describeGatewayInformation(input: AWS.StorageGateway.DescribeGatewayInformationInput, options: SdkCallOptions): Promise; /** * 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. */ describeMaintenanceStartTime(input: AWS.StorageGateway.DescribeMaintenanceStartTimeInput, options: SdkCallOptions): Promise; /** * Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways. */ describeNFSFileShares(input: AWS.StorageGateway.DescribeNFSFileSharesInput, options: SdkCallOptions): Promise; /** * Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways. */ describeSMBFileShares(input: AWS.StorageGateway.DescribeSMBFileSharesInput, options: SdkCallOptions): Promise; /** * Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways. */ describeSMBSettings(input: AWS.StorageGateway.DescribeSMBSettingsInput, options: SdkCallOptions): Promise; /** * Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types. */ describeSnapshotSchedule(input: AWS.StorageGateway.DescribeSnapshotScheduleInput, options: SdkCallOptions): Promise; /** * Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type. */ describeStorediSCSIVolumes(input: AWS.StorageGateway.DescribeStorediSCSIVolumesInput, options: SdkCallOptions): Promise; /** * Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. */ describeTapeArchives(input: AWS.StorageGateway.DescribeTapeArchivesInput, options: SdkCallOptions): Promise; /** * Returns a list of virtual tape recovery points that are available for the specified tape gateway. A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type. */ describeTapeRecoveryPoints(input: AWS.StorageGateway.DescribeTapeRecoveryPointsInput, options: SdkCallOptions): Promise; /** * Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type. */ describeTapes(input: AWS.StorageGateway.DescribeTapesInput, options: SdkCallOptions): Promise; /** * Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. */ describeUploadBuffer(input: AWS.StorageGateway.DescribeUploadBufferInput, options: SdkCallOptions): Promise; /** * Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type. */ describeVTLDevices(input: AWS.StorageGateway.DescribeVTLDevicesInput, options: SdkCallOptions): Promise; /** * Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. */ describeWorkingStorage(input: AWS.StorageGateway.DescribeWorkingStorageInput, options: SdkCallOptions): Promise; /** * Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type. */ detachVolume(input: AWS.StorageGateway.DetachVolumeInput, options: SdkCallOptions): Promise; /** * Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type. After a gateway is disabled, it cannot be enabled. */ disableGateway(input: AWS.StorageGateway.DisableGatewayInput, options: SdkCallOptions): Promise; /** * Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type. */ disassociateFileSystem(input: AWS.StorageGateway.DisassociateFileSystemInput, options: SdkCallOptions): Promise; /** * Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol. */ joinDomain(input: AWS.StorageGateway.JoinDomainInput, options: SdkCallOptions): Promise; /** * Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list. This operation is only supported for tape gateways. */ listAutomaticTapeCreationPolicies(input: AWS.StorageGateway.ListAutomaticTapeCreationPoliciesInput, options: SdkCallOptions): Promise; /** * Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling user account. This operation is only supported for S3 File Gateways. */ listFileShares(input: AWS.StorageGateway.ListFileSharesInput, options: SdkCallOptions): Promise; /** * Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways. */ listFileSystemAssociations(input: AWS.StorageGateway.ListFileSystemAssociationsInput, options: SdkCallOptions): Promise; /** * Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways. */ listGateways(input: AWS.StorageGateway.ListGatewaysInput, options: SdkCallOptions): Promise; /** * Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). */ listLocalDisks(input: AWS.StorageGateway.ListLocalDisksInput, options: SdkCallOptions): Promise; /** * Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types. */ listTagsForResource(input: AWS.StorageGateway.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools. This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools. */ listTapePools(input: AWS.StorageGateway.ListTapePoolsInput, options: SdkCallOptions): Promise; /** * Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS. This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type. */ listTapes(input: AWS.StorageGateway.ListTapesInput, options: SdkCallOptions): Promise; /** * Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types. */ listVolumeInitiators(input: AWS.StorageGateway.ListVolumeInitiatorsInput, options: SdkCallOptions): Promise; /** * Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation. */ listVolumeRecoveryPoints(input: AWS.StorageGateway.ListVolumeRecoveryPointsInput, options: SdkCallOptions): Promise; /** * Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API. The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types. */ listVolumes(input: AWS.StorageGateway.ListVolumesInput, options: SdkCallOptions): Promise; /** * Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to S3. Amazon S3. Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways. For more information, see Getting file upload notification in the Storage Gateway User Guide. */ notifyWhenUploaded(input: AWS.StorageGateway.NotifyWhenUploadedInput, options: SdkCallOptions): Promise; /** * Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway User Guide. This operation is Only supported for S3 File Gateways. When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes. Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway User Guide. Wait at least 60 seconds between consecutive RefreshCache API requests. RefreshCache does not evict cache entries if invoked consecutively within 60 seconds of a previous RefreshCache request. If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server. The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter. For more information, see Getting notified about file operations in the Storage Gateway User Guide. */ refreshCache(input: AWS.StorageGateway.RefreshCacheInput, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types. */ removeTagsFromResource(input: AWS.StorageGateway.RemoveTagsFromResourceInput, options: SdkCallOptions): Promise; /** * Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. */ resetCache(input: AWS.StorageGateway.ResetCacheInput, options: SdkCallOptions): Promise; /** * Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type. Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type. */ retrieveTapeArchive(input: AWS.StorageGateway.RetrieveTapeArchiveInput, options: SdkCallOptions): Promise; /** * Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points. */ retrieveTapeRecoveryPoint(input: AWS.StorageGateway.RetrieveTapeRecoveryPointInput, options: SdkCallOptions): Promise; /** * Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password. */ setLocalConsolePassword(input: AWS.StorageGateway.SetLocalConsolePasswordInput, options: SdkCallOptions): Promise; /** * Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess. This operation only supported for S3 File Gateways */ setSMBGuestPassword(input: AWS.StorageGateway.SetSMBGuestPasswordInput, options: SdkCallOptions): Promise; /** * Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM. If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway. If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway. */ shutdownGateway(input: AWS.StorageGateway.ShutdownGatewayInput, options: SdkCallOptions): Promise; /** * Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API. Starting this test will cause your gateway to go offline for a brief period. */ startAvailabilityMonitorTest(input: AWS.StorageGateway.StartAvailabilityMonitorTestInput, options: SdkCallOptions): Promise; /** * Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. */ startGateway(input: AWS.StorageGateway.StartGatewayInput, options: SdkCallOptions): Promise; /** * Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways. By default, there is no automatic tape creation policy. A gateway can have only one automatic tape creation policy. */ updateAutomaticTapeCreationPolicy(input: AWS.StorageGateway.UpdateAutomaticTapeCreationPolicyInput, options: SdkCallOptions): Promise; /** * Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule. By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. */ updateBandwidthRateLimit(input: AWS.StorageGateway.UpdateBandwidthRateLimitInput, options: SdkCallOptions): Promise; /** * Updates 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 initiate or update a gateway's bandwidth rate limit schedule. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits. */ updateBandwidthRateLimitSchedule(input: AWS.StorageGateway.UpdateBandwidthRateLimitScheduleInput, options: SdkCallOptions): Promise; /** * Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types. When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. */ updateChapCredentials(input: AWS.StorageGateway.UpdateChapCredentialsInput, options: SdkCallOptions): Promise; /** * Updates a file system association. This operation is only supported in the FSx File Gateways. */ updateFileSystemAssociation(input: AWS.StorageGateway.UpdateFileSystemAssociationInput, options: SdkCallOptions): Promise; /** * Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN. */ updateGatewayInformation(input: AWS.StorageGateway.UpdateGatewayInformationInput, options: SdkCallOptions): Promise; /** * 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. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state. A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively. */ updateGatewaySoftwareNow(input: AWS.StorageGateway.UpdateGatewaySoftwareNowInput, options: SdkCallOptions): Promise; /** * Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. */ updateMaintenanceStartTime(input: AWS.StorageGateway.UpdateMaintenanceStartTimeInput, options: SdkCallOptions): Promise; /** * Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways. To leave a file share field unchanged, set the corresponding input field to null. Updates the following file share settings: Default storage class for your S3 bucket Metadata defaults for your S3 bucket Allowed NFS clients for your file share Squash settings Write status of your file share */ updateNFSFileShare(input: AWS.StorageGateway.UpdateNFSFileShareInput, options: SdkCallOptions): Promise; /** * Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways. To leave a file share field unchanged, set the corresponding input field to null. File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share. */ updateSMBFileShare(input: AWS.StorageGateway.UpdateSMBFileShareInput, options: SdkCallOptions): Promise; /** * Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways. */ updateSMBFileShareVisibility(input: AWS.StorageGateway.UpdateSMBFileShareVisibilityInput, options: SdkCallOptions): Promise; /** * Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway. */ updateSMBLocalGroups(input: AWS.StorageGateway.UpdateSMBLocalGroupsInput, options: SdkCallOptions): Promise; /** * Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. This API is called Security level in the User Guide. A higher security level can affect performance of the gateway. */ updateSMBSecurityStrategy(input: AWS.StorageGateway.UpdateSMBSecurityStrategyInput, options: SdkCallOptions): Promise; /** * Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots. */ updateSnapshotSchedule(input: AWS.StorageGateway.UpdateSnapshotScheduleInput, options: SdkCallOptions): Promise; /** * Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type. */ updateVTLDeviceType(input: AWS.StorageGateway.UpdateVTLDeviceTypeInput, options: SdkCallOptions): Promise; } export interface STS { /** * Returns a set of temporary security credentials that you can use to access Amazon Web Services resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide. Permissions The temporary security credentials created by AssumeRole can be used to make API calls to any Amazon Web Services service with the following exception: You cannot call the Amazon Web Services STS GetFederationToken or GetSessionToken API operations. (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. When you create a role, you create two policies: A role trust policy that specifies who can assume the role and a permissions policy that specifies what can be done with the role. You specify the trusted principal who is allowed to assume the role in the role trust policy. To assume a role from a different account, your Amazon Web Services account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account. A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account. To allow a user to assume a role in the same account, you can do either of the following: Attach a policy to the user that allows the user to call AssumeRole (as long as the role's trust policy trusts the account). Add the user as a principal directly in the role's trust policy. You can do either because the role’s trust policy acts as an IAM resource-based policy. When a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide. Tags (Optional) You can pass tag key-value pairs to your session. These tags are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide. An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide. Using MFA with AssumeRole (Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. "Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}} For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide. To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces. */ assumeRole(input: AWS.STS.AssumeRoleRequest, options: SdkCallOptions): Promise; /** * Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based Amazon Web Services access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide. The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services services. Session Duration By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. Role chaining limits your CLI or Amazon Web Services API role session to a maximum of one hour. When you use the AssumeRole API operation to assume a role, you can specify the duration of your role session with the DurationSeconds parameter. You can specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum session duration setting for your role. However, if you assume a role using role chaining and provide a DurationSeconds parameter value greater than one hour, the operation fails. Permissions The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations. (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. Calling AssumeRoleWithSAML does not require the use of Amazon Web Services security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. Calling AssumeRoleWithSAML can result in an entry in your CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). Tags (Optional) You can configure your IdP to pass attributes into your SAML assertion as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide. An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. You can pass a session tag with the same key as a tag that is attached to the role. When you do, session tags override the role's tags with the same key. An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide. SAML Configuration Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy. For more information, see the following resources: About SAML 2.0-based Federation in the IAM User Guide. Creating SAML Identity Providers in the IAM User Guide. Configuring a Relying Party and Claims in the IAM User Guide. Creating a Role for SAML 2.0 Federation in the IAM User Guide. */ assumeRoleWithSAML(input: AWS.STS.AssumeRoleWithSAMLRequest, options: SdkCallOptions): Promise; /** * Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include the OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible identity provider such as Google or Amazon Cognito federated identities. For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application. To learn more about Amazon Cognito, see Amazon Cognito Overview in Amazon Web Services SDK for Android Developer Guide and Amazon Cognito Overview in the Amazon Web Services SDK for iOS Developer Guide. Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term Amazon Web Services credentials in the application. You also don't need to deploy server-based proxy services that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide. The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services service API operations. Session Duration By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide. Permissions The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations. (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. Tags (Optional) You can configure your IdP to pass attributes into your web identity token as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide. An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit. You can pass a session tag with the same key as a tag that is attached to the role. When you do, the session tag overrides the role tag with the same key. An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide. Identities Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. Calling AssumeRoleWithWebIdentity can result in an entry in your CloudTrail logs. The entry includes the Subject of the provided web identity token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification. For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources: Using Web Identity Federation API Operations for Mobile Apps and Federation Through a Web-based Identity Provider. Web Identity Federation Playground. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to Amazon Web Services. Amazon Web Services SDK for iOS Developer Guide and Amazon Web Services SDK for Android Developer Guide. These toolkits contain sample apps that show how to invoke the identity providers. The toolkits then show how to use the information from these providers to get and use temporary security credentials. Web Identity Federation with Mobile Applications. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. */ assumeRoleWithWebIdentity(input: AWS.STS.AssumeRoleWithWebIdentityRequest, options: SdkCallOptions): Promise; /** * Decodes additional information about the authorization status of a request from an encoded message returned in response to an Amazon Web Services request. For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can provide details about this authorization failure. Only certain Amazon Web Services operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code. The message is encoded because the details of the authorization status can contain privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions through an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action. The decoded message includes the following type of information: Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide. The principal who made the request. The requested action. The requested resource. The values of condition keys in the context of the user's request. */ decodeAuthorizationMessage(input: AWS.STS.DecodeAuthorizationMessageRequest, options: SdkCallOptions): Promise; /** * Returns the account identifier for the specified access key ID. Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about access keys, see Managing Access Keys for IAM Users in the IAM User Guide. When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account to which the keys belong. Access key IDs beginning with AKIA are long-term credentials for an IAM user or the Amazon Web Services account root user. Access key IDs beginning with ASIA are temporary credentials that are created using STS operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a credentials report to learn which IAM user owns the keys. To learn who requested the temporary credentials for an ASIA access key, view the STS events in your CloudTrail logs in the IAM User Guide. This operation does not indicate the state of the access key. The key might be active, inactive, or deleted. Active keys might not have permissions to perform an operation. Providing a deleted access key might return an error that the key doesn't exist. */ getAccessKeyInfo(input: AWS.STS.GetAccessKeyInfoRequest, options: SdkCallOptions): Promise; /** * Returns details about the IAM user or role whose credentials are used to call the operation. No permissions are required to perform this operation. If an administrator adds a policy to your IAM user or role that explicitly denies access to the sts:GetCallerIdentity action, you can still perform this operation. Permissions are not required because the same information is returned when an IAM user or role is denied access. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User Guide. */ getCallerIdentity(input: AWS.STS.GetCallerIdentityRequest, options: SdkCallOptions): Promise; /** * Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide. You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the IAM User Guide. You can also call GetFederationToken using the security credentials of an Amazon Web Services account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see IAM Best Practices in the IAM User Guide. Session duration The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is 43,200 seconds (12 hours). Temporary credentials obtained by using the Amazon Web Services account root user credentials have a maximum duration of 3,600 seconds (1 hour). Permissions You can use the temporary credentials created by GetFederationToken in any Amazon Web Services service except the following: You cannot call any IAM operations using the CLI or the Amazon Web Services API. You cannot call any STS operations except GetCallerIdentity. You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker. You can use the credentials to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions granted by the session policies. Tags (Optional) You can pass tag key-value pairs to your session. These are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide. You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the IAM User Guide. An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the user that you are federating has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the user tag. */ getFederationToken(input: AWS.STS.GetFederationTokenRequest, options: SdkCallOptions): Promise; /** * Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to API operations that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide. No permissions are required for users to perform this operation. The purpose of the sts:GetSessionToken operation is to authenticate the user using MFA. You cannot use policies to control authentication operations. For more information, see Permissions for GetSessionToken in the IAM User Guide. Session Duration The GetSessionToken operation must be called by using the long-term Amazon Web Services security credentials of the Amazon Web Services account root user or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour. Permissions The temporary security credentials created by GetSessionToken can be used to make API calls to any Amazon Web Services service with the following exceptions: You cannot call any IAM API operations unless MFA authentication information is included in the request. You cannot call any STS API except AssumeRole or GetCallerIdentity. We recommend that you do not call GetSessionToken with Amazon Web Services account root user credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with Amazon Web Services. The credentials that are returned by GetSessionToken are based on permissions associated with the user whose credentials were used to call the operation. If GetSessionToken is called using Amazon Web Services account root user credentials, the temporary credentials have root user permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide. */ getSessionToken(input: AWS.STS.GetSessionTokenRequest, options: SdkCallOptions): Promise; } export interface Support { /** * Adds one or more attachments to an attachment set. An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ addAttachmentsToSet(input: AWS.Support.AddAttachmentsToSetRequest, options: SdkCallOptions): Promise; /** * Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ addCommunicationToCase(input: AWS.Support.AddCommunicationToCaseRequest, options: SdkCallOptions): Promise; /** * Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page. The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways: Submit a request from the Amazon Web Services Support Center Create Case page. Use the Service Quotas RequestServiceQuotaIncrease operation. A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case. The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ createCase(input: AWS.Support.CreateCaseRequest, options: SdkCallOptions): Promise; /** * Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ describeAttachment(input: AWS.Support.DescribeAttachmentRequest, options: SdkCallOptions): Promise; /** * Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return. The response returns the following in JSON format: One or more CaseDetails data types. One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ describeCases(input: AWS.Support.DescribeCasesRequest, options: SdkCallOptions): Promise; /** * Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ describeCommunications(input: AWS.Support.DescribeCommunicationsRequest, options: SdkCallOptions): Promise; /** * Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories. The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ describeServices(input: AWS.Support.DescribeServicesRequest, options: SdkCallOptions): Promise; /** * Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ describeSeverityLevels(input: AWS.Support.DescribeSeverityLevelsRequest, options: SdkCallOptions): Promise; /** * Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ describeTrustedAdvisorCheckRefreshStatuses(input: AWS.Support.DescribeTrustedAdvisorCheckRefreshStatusesRequest, options: SdkCallOptions): Promise; /** * Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: TrustedAdvisorCategorySpecificSummary TrustedAdvisorResourceDetail TrustedAdvisorResourcesSummary In addition, the response contains these fields: status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available. timestamp - The time of the last refresh of the check. checkId - The unique identifier for the check. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ describeTrustedAdvisorCheckResult(input: AWS.Support.DescribeTrustedAdvisorCheckResultRequest, options: SdkCallOptions): Promise; /** * Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains an array of TrustedAdvisorCheckSummary objects. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ describeTrustedAdvisorCheckSummaries(input: AWS.Support.DescribeTrustedAdvisorCheckSummariesRequest, options: SdkCallOptions): Promise; /** * Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The Amazon Web Services Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check. */ describeTrustedAdvisorChecks(input: AWS.Support.DescribeTrustedAdvisorChecksRequest, options: SdkCallOptions): Promise; /** * Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error. The response contains a TrustedAdvisorCheckRefreshStatus object. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ refreshTrustedAdvisorCheck(input: AWS.Support.RefreshTrustedAdvisorCheckRequest, options: SdkCallOptions): Promise; /** * Resolves a support case. This operation takes a caseId and returns the initial and final state of the case. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support. */ resolveCase(input: AWS.Support.ResolveCaseRequest, options: SdkCallOptions): Promise; } export interface SupportApp { /** * Creates a Slack channel configuration for your Amazon Web Services account. You can add up to 5 Slack workspaces for your account. You can add up to 20 Slack channels for your account. A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel. We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels. */ createSlackChannelConfiguration(input: AWS.SupportApp.CreateSlackChannelConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App. */ deleteAccountAlias(input: AWS.SupportApp.DeleteAccountAliasRequest, options: SdkCallOptions): Promise; /** * Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel. */ deleteSlackChannelConfiguration(input: AWS.SupportApp.DeleteSlackChannelConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace. */ deleteSlackWorkspaceConfiguration(input: AWS.SupportApp.DeleteSlackWorkspaceConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App. */ getAccountAlias(input: AWS.SupportApp.GetAccountAliasRequest, options: SdkCallOptions): Promise; /** * Lists the Slack channel configurations for an Amazon Web Services account. */ listSlackChannelConfigurations(input: AWS.SupportApp.ListSlackChannelConfigurationsRequest, options: SdkCallOptions): Promise; /** * Lists the Slack workspace configurations for an Amazon Web Services account. */ listSlackWorkspaceConfigurations(input: AWS.SupportApp.ListSlackWorkspaceConfigurationsRequest, options: SdkCallOptions): Promise; /** * Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App. */ putAccountAlias(input: AWS.SupportApp.PutAccountAliasRequest, options: SdkCallOptions): Promise; /** * Updates the configuration for a Slack channel, such as case update notifications. */ updateSlackChannelConfiguration(input: AWS.SupportApp.UpdateSlackChannelConfigurationRequest, options: SdkCallOptions): Promise; } export interface SWF { /** * Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ countClosedWorkflowExecutions(input: AWS.SWF.CountClosedWorkflowExecutionsInput, options: SdkCallOptions): Promise; /** * Returns the number of open workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ countOpenWorkflowExecutions(input: AWS.SWF.CountOpenWorkflowExecutionsInput, options: SdkCallOptions): Promise; /** * Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ countPendingActivityTasks(input: AWS.SWF.CountPendingActivityTasksInput, options: SdkCallOptions): Promise; /** * Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ countPendingDecisionTasks(input: AWS.SWF.CountPendingDecisionTasksInput, options: SdkCallOptions): Promise; /** * Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ deprecateActivityType(input: AWS.SWF.DeprecateActivityTypeInput, options: SdkCallOptions): Promise<{}>; /** * Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ deprecateDomain(input: AWS.SWF.DeprecateDomainInput, options: SdkCallOptions): Promise<{}>; /** * Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ deprecateWorkflowType(input: AWS.SWF.DeprecateWorkflowTypeInput, options: SdkCallOptions): Promise<{}>; /** * Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ describeActivityType(input: AWS.SWF.DescribeActivityTypeInput, options: SdkCallOptions): Promise; /** * Returns information about the specified domain, including description and status. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ describeDomain(input: AWS.SWF.DescribeDomainInput, options: SdkCallOptions): Promise; /** * Returns information about the specified workflow execution including its type and some statistics. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ describeWorkflowExecution(input: AWS.SWF.DescribeWorkflowExecutionInput, options: SdkCallOptions): Promise; /** * Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ describeWorkflowType(input: AWS.SWF.DescribeWorkflowTypeInput, options: SdkCallOptions): Promise; /** * Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ getWorkflowExecutionHistory(input: AWS.SWF.GetWorkflowExecutionHistoryInput, options: SdkCallOptions): Promise; /** * Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ listActivityTypes(input: AWS.SWF.ListActivityTypesInput, options: SdkCallOptions): Promise; /** * Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ listClosedWorkflowExecutions(input: AWS.SWF.ListClosedWorkflowExecutionsInput, options: SdkCallOptions): Promise; /** * Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ listDomains(input: AWS.SWF.ListDomainsInput, options: SdkCallOptions): Promise; /** * Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ listOpenWorkflowExecutions(input: AWS.SWF.ListOpenWorkflowExecutionsInput, options: SdkCallOptions): Promise; /** * List tags for a given domain. */ listTagsForResource(input: AWS.SWF.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ listWorkflowTypes(input: AWS.SWF.ListWorkflowTypesInput, options: SdkCallOptions): Promise; /** * Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly. Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request). Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ pollForActivityTask(input: AWS.SWF.PollForActivityTaskInput, options: SdkCallOptions): Promise; /** * Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task. This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string. Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout). Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ pollForDecisionTask(input: AWS.SWF.PollForDecisionTaskInput, options: SdkCallOptions): Promise; /** * Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true. This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType. This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker. The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ recordActivityTaskHeartbeat(input: AWS.SWF.RecordActivityTaskHeartbeatInput, options: SdkCallOptions): Promise; /** * Registers a new activity type along with its configuration settings in the specified domain. A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ registerActivityType(input: AWS.SWF.RegisterActivityTypeInput, options: SdkCallOptions): Promise<{}>; /** * Registers a new domain. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ registerDomain(input: AWS.SWF.RegisterDomainInput, options: SdkCallOptions): Promise<{}>; /** * Registers a new workflow type and its configuration settings in the specified domain. The retention period for the workflow history is set by the RegisterDomain action. If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name. version: String constraint. The key is swf:version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ registerWorkflowType(input: AWS.SWF.RegisterWorkflowTypeInput, options: SdkCallOptions): Promise<{}>; /** * Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event. If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ requestCancelWorkflowExecution(input: AWS.SWF.RequestCancelWorkflowExecutionInput, options: SdkCallOptions): Promise<{}>; /** * Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument. These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history. Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ respondActivityTaskCanceled(input: AWS.SWF.RespondActivityTaskCanceledInput, options: SdkCallOptions): Promise<{}>; /** * Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history. If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ respondActivityTaskCompleted(input: AWS.SWF.RespondActivityTaskCompletedInput, options: SdkCallOptions): Promise<{}>; /** * Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ respondActivityTaskFailed(input: AWS.SWF.RespondActivityTaskFailedInput, options: SdkCallOptions): Promise<{}>; /** * Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task. A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history. Access Control If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ respondDecisionTaskCompleted(input: AWS.SWF.RespondDecisionTaskCompletedInput, options: SdkCallOptions): Promise<{}>; /** * Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided). If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. If the specified workflow execution isn't open, this method fails with UnknownResource. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ signalWorkflowExecution(input: AWS.SWF.SignalWorkflowExecutionInput, options: SdkCallOptions): Promise<{}>; /** * Starts an execution of the workflow type in the specified domain using the provided workflowId and input data. This action returns the newly started workflow execution. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. tagList.member.0: The key is swf:tagList.member.0. tagList.member.1: The key is swf:tagList.member.1. tagList.member.2: The key is swf:tagList.member.2. tagList.member.3: The key is swf:tagList.member.3. tagList.member.4: The key is swf:tagList.member.4. taskList: String constraint. The key is swf:taskList.name. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ startWorkflowExecution(input: AWS.SWF.StartWorkflowExecutionInput, options: SdkCallOptions): Promise; /** * Add a tag to a Amazon SWF domain. Amazon SWF supports a maximum of 50 tags per resource. */ tagResource(input: AWS.SWF.TagResourceInput, options: SdkCallOptions): Promise<{}>; /** * Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution. If the identified workflow execution was in progress, it is terminated immediately. If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ terminateWorkflowExecution(input: AWS.SWF.TerminateWorkflowExecutionInput, options: SdkCallOptions): Promise<{}>; /** * Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name. activityType.version: String constraint. The key is swf:activityType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ undeprecateActivityType(input: AWS.SWF.UndeprecateActivityTypeInput, options: SdkCallOptions): Promise<{}>; /** * Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. You cannot use an IAM policy to constrain this action's parameters. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ undeprecateDomain(input: AWS.SWF.UndeprecateDomainInput, options: SdkCallOptions): Promise<{}>; /** * Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type. This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: Use a Resource element with the domain name to limit the action to only specified domains. Use an Action element to allow or deny permission to call this action. Constrain the following parameters by using a Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name. workflowType.version: String constraint. The key is swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. */ undeprecateWorkflowType(input: AWS.SWF.UndeprecateWorkflowTypeInput, options: SdkCallOptions): Promise<{}>; /** * Remove a tag from a Amazon SWF domain. */ untagResource(input: AWS.SWF.UntagResourceInput, options: SdkCallOptions): Promise<{}>; } export interface Synthetics { /** * Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group. You must run this operation in the Region where the canary exists. */ associateResource(input: AWS.Synthetics.AssociateResourceRequest, options: SdkCallOptions): Promise; /** * Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once. Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead. To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries. */ createCanary(input: AWS.Synthetics.CreateCanaryRequest, options: SdkCallOptions): Promise; /** * Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group. Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view. Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region. Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups. */ createGroup(input: AWS.Synthetics.CreateGroupRequest, options: SdkCallOptions): Promise; /** * Permanently deletes the specified canary. If you specify DeleteLambda to true, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary. Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following: The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName . Amazon S3 objects and buckets, such as the canary's artifact location. IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName . CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName . Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary. */ deleteCanary(input: AWS.Synthetics.DeleteCanaryRequest, options: SdkCallOptions): Promise; /** * Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group. Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN. */ deleteGroup(input: AWS.Synthetics.DeleteGroupRequest, options: SdkCallOptions): Promise; /** * This operation returns a list of the canaries in your account, along with full details about each canary. This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries. */ describeCanaries(input: AWS.Synthetics.DescribeCanariesRequest, options: SdkCallOptions): Promise; /** * Use this operation to see information from the most recent run of each canary that you have created. This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries. */ describeCanariesLastRun(input: AWS.Synthetics.DescribeCanariesLastRunRequest, options: SdkCallOptions): Promise; /** * Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions. */ describeRuntimeVersions(input: AWS.Synthetics.DescribeRuntimeVersionsRequest, options: SdkCallOptions): Promise; /** * Removes a canary from a group. You must run this operation in the Region where the canary exists. */ disassociateResource(input: AWS.Synthetics.DisassociateResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries. */ getCanary(input: AWS.Synthetics.GetCanaryRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of runs for a specified canary. */ getCanaryRuns(input: AWS.Synthetics.GetCanaryRunsRequest, options: SdkCallOptions): Promise; /** * Returns information about one group. Groups are a global resource, so you can use this operation from any Region. */ getGroup(input: AWS.Synthetics.GetGroupRequest, options: SdkCallOptions): Promise; /** * Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region. */ listAssociatedGroups(input: AWS.Synthetics.ListAssociatedGroupsRequest, options: SdkCallOptions): Promise; /** * This operation returns a list of the ARNs of the canaries that are associated with the specified group. */ listGroupResources(input: AWS.Synthetics.ListGroupResourcesRequest, options: SdkCallOptions): Promise; /** * Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned. */ listGroups(input: AWS.Synthetics.ListGroupsRequest, options: SdkCallOptions): Promise; /** * Displays the tags associated with a canary or group. */ listTagsForResource(input: AWS.Synthetics.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary. */ startCanary(input: AWS.Synthetics.StartCanaryRequest, options: SdkCallOptions): Promise; /** * Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run. You can use StartCanary to start it running again with the canary’s current schedule at any point in the future. */ stopCanary(input: AWS.Synthetics.StopCanaryRequest, options: SdkCallOptions): Promise; /** * Assigns one or more tags (key-value pairs) to the specified canary or group. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary or group. */ tagResource(input: AWS.Synthetics.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. */ untagResource(input: AWS.Synthetics.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the configuration of a canary that has already been created. You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource. */ updateCanary(input: AWS.Synthetics.UpdateCanaryRequest, options: SdkCallOptions): Promise; } export interface Textract { /** * Analyzes an input document for relationships between detected items. The types of information returned are as follows: Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table. Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes). Queries.A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that connect it to the query asked. This Block also contains a location and attached confidence score. Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status. You can choose which type of analysis to perform by specifying the FeatureTypes list. The output is returned in a list of Block objects. AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis. For more information, see Document Text Analysis. */ analyzeDocument(input: AWS.Textract.AnalyzeDocumentRequest, options: SdkCallOptions): Promise; /** * AnalyzeExpense synchronously analyzes an input document for financially related relationships between text. Information is returned as ExpenseDocuments and seperated as follows. LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt. SummaryFields- Contains all other information a receipt, such as header information or the vendors name. */ analyzeExpense(input: AWS.Textract.AnalyzeExpenseRequest, options: SdkCallOptions): Promise; /** * Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text.Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data. */ analyzeID(input: AWS.Textract.AnalyzeIDRequest, options: SdkCallOptions): Promise; /** * Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPEG, PNG, PDF, or TIFF format. DetectDocumentText returns the detected text in an array of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD. DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection. For more information, see Document Text Detection. */ detectDocumentText(input: AWS.Textract.DetectDocumentTextRequest, options: SdkCallOptions): Promise; /** * Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document. You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis. GetDocumentAnalysis returns an array of Block objects. The following types of information are returned: Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table. Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter). Queries. A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that connect it to the query asked. This Block also contains a location and attached confidence score Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status. Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis. For more information, see Document Text Analysis. */ getDocumentAnalysis(input: AWS.Textract.GetDocumentAnalysisRequest, options: SdkCallOptions): Promise; /** * Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection. GetDocumentTextDetection returns an array of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD. Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection. For more information, see Document Text Detection. */ getDocumentTextDetection(input: AWS.Textract.GetDocumentTextDetectionRequest, options: SdkCallOptions): Promise; /** * Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts. You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis. Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis. For more information, see Analyzing Invoices and Receipts. */ getExpenseAnalysis(input: AWS.Textract.GetExpenseAnalysisRequest, options: SdkCallOptions): Promise; /** * Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements. StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document. StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis. For more information, see Document Text Analysis. */ startDocumentAnalysis(input: AWS.Textract.StartDocumentAnalysisRequest, options: SdkCallOptions): Promise; /** * Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document. StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection. For more information, see Document Text Detection. */ startDocumentTextDetection(input: AWS.Textract.StartDocumentTextDetectionRequest, options: SdkCallOptions): Promise; /** * Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names. StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket. StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis. For more information, see Analyzing Invoices and Receipts. */ startExpenseAnalysis(input: AWS.Textract.StartExpenseAnalysisRequest, options: SdkCallOptions): Promise; } export interface TimestreamQuery { /** * Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details. */ cancelQuery(input: AWS.TimestreamQuery.CancelQueryRequest, options: SdkCallOptions): Promise; /** * Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations. */ createScheduledQuery(input: AWS.TimestreamQuery.CreateScheduledQueryRequest, options: SdkCallOptions): Promise; /** * Deletes a given scheduled query. This is an irreversible operation. */ deleteScheduledQuery(input: AWS.TimestreamQuery.DeleteScheduledQueryRequest, options: SdkCallOptions): Promise<{}>; /** * DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query. Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless: You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream Your application uses a programming language that does not yet have SDK support You require better control over the client-side implementation For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern. */ describeEndpoints(input: AWS.TimestreamQuery.DescribeEndpointsRequest, options: SdkCallOptions): Promise; /** * Provides detailed information about a scheduled query. */ describeScheduledQuery(input: AWS.TimestreamQuery.DescribeScheduledQueryRequest, options: SdkCallOptions): Promise; /** * You can use this API to run a scheduled query manually. */ executeScheduledQuery(input: AWS.TimestreamQuery.ExecuteScheduledQueryRequest, options: SdkCallOptions): Promise<{}>; /** * Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent. */ listScheduledQueries(input: AWS.TimestreamQuery.ListScheduledQueriesRequest, options: SdkCallOptions): Promise; /** * List all tags on a Timestream query resource. */ listTagsForResource(input: AWS.TimestreamQuery.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with the PrepareQueryRequest$ValidateOnly set to true. */ prepareQuery(input: AWS.TimestreamQuery.PrepareQueryRequest, options: SdkCallOptions): Promise; /** * Query is a synchronous operation that enables you to run a query against your Amazon Timestream data. Query will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the code sample for details. Your query request will fail in the following cases: If you submit a Query request with the same client token outside of the 5-minute idempotency window. If you submit a Query request with the same client token, but change other parameters, within the 5-minute idempotency window. If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message: Query aborted as max page response size has been exceeded by the output result row If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error. */ query(input: AWS.TimestreamQuery.QueryRequest, options: SdkCallOptions): Promise; /** * Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. */ tagResource(input: AWS.TimestreamQuery.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the association of tags from a Timestream query resource. */ untagResource(input: AWS.TimestreamQuery.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Update a scheduled query. */ updateScheduledQuery(input: AWS.TimestreamQuery.UpdateScheduledQueryRequest, options: SdkCallOptions): Promise<{}>; } export interface TimestreamWrite { /** * Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. Refer to Amazon Web Services managed KMS keys for more info. Service quotas apply. See code sample for details. */ createDatabase(input: AWS.TimestreamWrite.CreateDatabaseRequest, options: SdkCallOptions): Promise; /** * The CreateTable operation adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. See code sample for details. */ createTable(input: AWS.TimestreamWrite.CreateTableRequest, options: SdkCallOptions): Promise; /** * Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time series data from its tables cannot be recovered. All tables in the database must be deleted first, or a ValidationException error will be thrown. Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent. See code sample for details. */ deleteDatabase(input: AWS.TimestreamWrite.DeleteDatabaseRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time series data stored in the table cannot be recovered. Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent. See code sample for details. */ deleteTable(input: AWS.TimestreamWrite.DeleteTableRequest, options: SdkCallOptions): Promise<{}>; /** * Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details. */ describeDatabase(input: AWS.TimestreamWrite.DescribeDatabaseRequest, options: SdkCallOptions): Promise; /** * DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query. Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless: You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream Your application uses a programming language that does not yet have SDK support You require better control over the client-side implementation For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern. */ describeEndpoints(input: AWS.TimestreamWrite.DescribeEndpointsRequest, options: SdkCallOptions): Promise; /** * Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. See code sample for details. */ describeTable(input: AWS.TimestreamWrite.DescribeTableRequest, options: SdkCallOptions): Promise; /** * Returns a list of your Timestream databases. Service quotas apply. See code sample for details. */ listDatabases(input: AWS.TimestreamWrite.ListDatabasesRequest, options: SdkCallOptions): Promise; /** * A list of tables, along with the name, status and retention properties of each table. See code sample for details. */ listTables(input: AWS.TimestreamWrite.ListTablesRequest, options: SdkCallOptions): Promise; /** * List all tags on a Timestream resource. */ listTagsForResource(input: AWS.TimestreamWrite.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. */ tagResource(input: AWS.TimestreamWrite.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the association of tags from a Timestream resource. */ untagResource(input: AWS.TimestreamWrite.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer wins. See code sample for details. */ updateDatabase(input: AWS.TimestreamWrite.UpdateDatabaseRequest, options: SdkCallOptions): Promise; /** * Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store. See code sample for details. */ updateTable(input: AWS.TimestreamWrite.UpdateTableRequest, options: SdkCallOptions): Promise; /** * The WriteRecords operation enables you to write your time series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you with a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database. Timestream support eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply. See code sample for details. Upserts You can use the Version parameter in a WriteRecords request to update data points. Timestream tracks a version number with each record. Version defaults to 1 when not specified for the record in the request. Timestream will update an existing record’s measure value along with its Version upon receiving a write request with a higher Version number for that record. Upon receiving an update request where the measure value is the same as that of the existing record, Timestream still updates Version, if it is greater than the existing value of Version. You can update a data point as many times as desired, as long as the value of Version continuously increases. For example, suppose you write a new record without indicating Version in the request. Timestream will store this record, and set Version to 1. Now, suppose you try to update this record with a WriteRecords request of the same record with a different measure value but, like before, do not provide Version. In this case, Timestream will reject this update with a RejectedRecordsException since the updated record’s version is not greater than the existing value of Version. However, if you were to resend the update request with Version set to 2, Timestream would then succeed in updating the record’s value, and the Version would be set to 2. Next, suppose you sent a WriteRecords request with this same record and an identical measure value, but with Version set to 3. In this case, Timestream would only update Version to 3. Any further updates would need to send a version number greater than 3, or the update requests would receive a RejectedRecordsException. */ writeRecords(input: AWS.TimestreamWrite.WriteRecordsRequest, options: SdkCallOptions): Promise; } export interface TranscribeService { /** * Creates a new Call Analytics category. All categories are automatically applied to your Call Analytics jobs. Note that in order to apply your categories to your jobs, you must create them before submitting your job request, as categories cannot be applied retroactively. Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and . To update an existing category, see . To learn more about: Call Analytics categories, see Creating categories Using rules, see Rule criteria and refer to the data type Call Analytics, see Analyzing call center audio with Call Analytics */ createCallAnalyticsCategory(input: AWS.TranscribeService.CreateCallAnalyticsCategoryRequest, options: SdkCallOptions): Promise; /** * Creates a new custom language model. When creating a new language model, you must specify: If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model The location of your training and tuning files (this must be an Amazon S3 URI) The language of your model A unique name for your model For more information, see Custom language models. */ createLanguageModel(input: AWS.TranscribeService.CreateLanguageModelRequest, options: SdkCallOptions): Promise; /** * Creates a new custom medical vocabulary. Prior to creating a new medical vocabulary, you must first upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more information, see Creating a custom vocabulary. */ createMedicalVocabulary(input: AWS.TranscribeService.CreateMedicalVocabularyRequest, options: SdkCallOptions): Promise; /** * Creates a new custom vocabulary. When creating a new vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request, or you can include a list of terms directly in your request using the Phrases flag. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more information, see Creating a custom vocabulary. */ createVocabulary(input: AWS.TranscribeService.CreateVocabularyRequest, options: SdkCallOptions): Promise; /** * Creates a new custom vocabulary filter. You can use vocabulary filters to mask, delete, or flag specific words from your transcript. Vocabulary filters are commonly used to mask profanity in transcripts. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more information, see Using vocabulary filtering with unwanted words. */ createVocabularyFilter(input: AWS.TranscribeService.CreateVocabularyFilterRequest, options: SdkCallOptions): Promise; /** * Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive. */ deleteCallAnalyticsCategory(input: AWS.TranscribeService.DeleteCallAnalyticsCategoryRequest, options: SdkCallOptions): Promise; /** * Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive. */ deleteCallAnalyticsJob(input: AWS.TranscribeService.DeleteCallAnalyticsJobRequest, options: SdkCallOptions): Promise; /** * Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. Language model names are case sensitive. */ deleteLanguageModel(input: AWS.TranscribeService.DeleteLanguageModelRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive. */ deleteMedicalTranscriptionJob(input: AWS.TranscribeService.DeleteMedicalTranscriptionJobRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a custom medical vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName. Vocabulary names are case sensitive. */ deleteMedicalVocabulary(input: AWS.TranscribeService.DeleteMedicalVocabularyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive. */ deleteTranscriptionJob(input: AWS.TranscribeService.DeleteTranscriptionJobRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName. Vocabulary names are case sensitive. */ deleteVocabulary(input: AWS.TranscribeService.DeleteVocabularyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter you want to delete using VocabularyFilterName. Vocabulary filter names are case sensitive. */ deleteVocabularyFilter(input: AWS.TranscribeService.DeleteVocabularyFilterRequest, options: SdkCallOptions): Promise<{}>; /** * Provides information about the specified custom language model. This operation also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. If you tried to create a new custom language model and the request wasn't successful, you can use DescribeLanguageModel to help identify the reason for this failure. To get a list of your custom language models, use the operation. */ describeLanguageModel(input: AWS.TranscribeService.DescribeLanguageModelRequest, options: SdkCallOptions): Promise; /** * Provides information about the specified Call Analytics category. To get a list of your Call Analytics categories, use the operation. */ getCallAnalyticsCategory(input: AWS.TranscribeService.GetCallAnalyticsCategoryRequest, options: SdkCallOptions): Promise; /** * Provides information about the specified Call Analytics job. To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri. If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri. To get a list of your Call Analytics jobs, use the operation. */ getCallAnalyticsJob(input: AWS.TranscribeService.GetCallAnalyticsJobRequest, options: SdkCallOptions): Promise; /** * Provides information about the specified medical transcription job. To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. To get a list of your medical transcription jobs, use the operation. */ getMedicalTranscriptionJob(input: AWS.TranscribeService.GetMedicalTranscriptionJobRequest, options: SdkCallOptions): Promise; /** * Provides information about the specified custom medical vocabulary. To view the status of the specified medical vocabulary, check the VocabularyState field. If the status is READY, your vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed. To get a list of your custom medical vocabularies, use the operation. */ getMedicalVocabulary(input: AWS.TranscribeService.GetMedicalVocabularyRequest, options: SdkCallOptions): Promise; /** * Provides information about the specified transcription job. To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri. To get a list of your transcription jobs, use the operation. */ getTranscriptionJob(input: AWS.TranscribeService.GetTranscriptionJobRequest, options: SdkCallOptions): Promise; /** * Provides information about the specified custom vocabulary. To view the status of the specified vocabulary, check the VocabularyState field. If the status is READY, your vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed. To get a list of your custom vocabularies, use the operation. */ getVocabulary(input: AWS.TranscribeService.GetVocabularyRequest, options: SdkCallOptions): Promise; /** * Provides information about the specified custom vocabulary filter. To view the status of the specified vocabulary filter, check the VocabularyState field. If the status is READY, your vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary filter failed. To get a list of your custom vocabulary filters, use the operation. */ getVocabularyFilter(input: AWS.TranscribeService.GetVocabularyFilterRequest, options: SdkCallOptions): Promise; /** * Provides a list of Call Analytics categories, including all rules that make up each category. To get detailed information about a specific Call Analytics category, use the operation. */ listCallAnalyticsCategories(input: AWS.TranscribeService.ListCallAnalyticsCategoriesRequest, options: SdkCallOptions): Promise; /** * Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned. To get detailed information about a specific Call Analytics job, use the operation. */ listCallAnalyticsJobs(input: AWS.TranscribeService.ListCallAnalyticsJobsRequest, options: SdkCallOptions): Promise; /** * Provides a list of custom language models that match the specified criteria. If no criteria are specified, all language models are returned. To get detailed information about a specific custom language model, use the operation. */ listLanguageModels(input: AWS.TranscribeService.ListLanguageModelsRequest, options: SdkCallOptions): Promise; /** * Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned. To get detailed information about a specific medical transcription job, use the operation. */ listMedicalTranscriptionJobs(input: AWS.TranscribeService.ListMedicalTranscriptionJobsRequest, options: SdkCallOptions): Promise; /** * Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned. To get detailed information about a specific custom medical vocabulary, use the operation. */ listMedicalVocabularies(input: AWS.TranscribeService.ListMedicalVocabulariesRequest, options: SdkCallOptions): Promise; /** * Lists all tags associated with the specified transcription job, vocabulary, model, or resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. */ listTagsForResource(input: AWS.TranscribeService.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned. To get detailed information about a specific transcription job, use the operation. */ listTranscriptionJobs(input: AWS.TranscribeService.ListTranscriptionJobsRequest, options: SdkCallOptions): Promise; /** * Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned. To get detailed information about a specific custom vocabulary, use the operation. */ listVocabularies(input: AWS.TranscribeService.ListVocabulariesRequest, options: SdkCallOptions): Promise; /** * Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned. To get detailed information about a specific custom vocabulary filter, use the operation. */ listVocabularyFilters(input: AWS.TranscribeService.ListVocabularyFiltersRequest, options: SdkCallOptions): Promise; /** * Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request. In addition to many of the standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics. If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories. To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartCallAnalyticsJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. CallAnalyticsJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file. With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri field of your response. */ startCallAnalyticsJob(input: AWS.TranscribeService.StartCallAnalyticsJobRequest, options: SdkCallOptions): Promise; /** * Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request. In addition to many of the standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works. To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the S3 location of the file using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. LanguageCode: This must be en-US. OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey. Specialty: This must be PRIMARYCARE. Type: Choose whether your audio is a conversation or a dictation. */ startMedicalTranscriptionJob(input: AWS.TranscribeService.StartMedicalTranscriptionJobRequest, options: SdkCallOptions): Promise; /** * Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you don't know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you. */ startTranscriptionJob(input: AWS.TranscribeService.StartTranscriptionJobRequest, options: SdkCallOptions): Promise; /** * Adds one or more custom tags, each in the form of a key:value pair, to the specified resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. */ tagResource(input: AWS.TranscribeService.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified Amazon Transcribe resource. If you include UntagResource in your request, you must also include ResourceArn and TagKeys. */ untagResource(input: AWS.TranscribeService.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category. To create a new category, see . */ updateCallAnalyticsCategory(input: AWS.TranscribeService.UpdateCallAnalyticsCategoryRequest, options: SdkCallOptions): Promise; /** * Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing vocabulary. */ updateMedicalVocabulary(input: AWS.TranscribeService.UpdateMedicalVocabularyRequest, options: SdkCallOptions): Promise; /** * Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing vocabulary. */ updateVocabulary(input: AWS.TranscribeService.UpdateVocabularyRequest, options: SdkCallOptions): Promise; /** * Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing vocabulary filter. */ updateVocabularyFilter(input: AWS.TranscribeService.UpdateVocabularyFilterRequest, options: SdkCallOptions): Promise; } export interface Transfer { /** * Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability. */ createAccess(input: AWS.Transfer.CreateAccessRequest, options: SdkCallOptions): Promise; /** * Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes. The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId. */ createAgreement(input: AWS.Transfer.CreateAgreementRequest, options: SdkCallOptions): Promise; /** * Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol. The connector is required for sending files from a customer's non Amazon Web Services server. */ createConnector(input: AWS.Transfer.CreateConnectorRequest, options: SdkCallOptions): Promise; /** * Creates the profile for the AS2 process. The agreement is between the partner and the AS2 process. */ createProfile(input: AWS.Transfer.CreateProfileRequest, options: SdkCallOptions): Promise; /** * Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. */ createServer(input: AWS.Transfer.CreateServerRequest, options: SdkCallOptions): Promise; /** * Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users. */ createUser(input: AWS.Transfer.CreateUserRequest, options: SdkCallOptions): Promise; /** * Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations. */ createWorkflow(input: AWS.Transfer.CreateWorkflowRequest, options: SdkCallOptions): Promise; /** * Allows you to delete the access specified in the ServerID and ExternalID parameters. */ deleteAccess(input: AWS.Transfer.DeleteAccessRequest, options: SdkCallOptions): Promise<{}>; /** * Delete the agreement that's specified in the provided AgreementId. */ deleteAgreement(input: AWS.Transfer.DeleteAgreementRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the certificate that's specified in the CertificateId parameter. */ deleteCertificate(input: AWS.Transfer.DeleteCertificateRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the agreement that's specified in the provided ConnectorId. */ deleteConnector(input: AWS.Transfer.DeleteConnectorRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the host key that's specified in the HoskKeyId parameter. */ deleteHostKey(input: AWS.Transfer.DeleteHostKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the profile that's specified in the ProfileId parameter. */ deleteProfile(input: AWS.Transfer.DeleteProfileRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation. */ deleteServer(input: AWS.Transfer.DeleteServerRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes a user's Secure Shell (SSH) public key. */ deleteSshPublicKey(input: AWS.Transfer.DeleteSshPublicKeyRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the user belonging to a file transfer protocol-enabled server you specify. No response returns from this operation. When you delete a user from a server, the user's information is lost. */ deleteUser(input: AWS.Transfer.DeleteUserRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified workflow. */ deleteWorkflow(input: AWS.Transfer.DeleteWorkflowRequest, options: SdkCallOptions): Promise<{}>; /** * Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId. The response from this call returns the properties of the access that is associated with the ServerId value that was specified. */ describeAccess(input: AWS.Transfer.DescribeAccessRequest, options: SdkCallOptions): Promise; /** * Describes the agreement that's identified by the AgreementId. */ describeAgreement(input: AWS.Transfer.DescribeAgreementRequest, options: SdkCallOptions): Promise; /** * Describes the certificate that's identified by the CertificateId. */ describeCertificate(input: AWS.Transfer.DescribeCertificateRequest, options: SdkCallOptions): Promise; /** * Describes the connector that's identified by the ConnectorId. */ describeConnector(input: AWS.Transfer.DescribeConnectorRequest, options: SdkCallOptions): Promise; /** * You can use DescribeExecution to check the details of the execution of the specified workflow. */ describeExecution(input: AWS.Transfer.DescribeExecutionRequest, options: SdkCallOptions): Promise; /** * Returns the details of the host key that's specified by the HostKeyId and ServerId. */ describeHostKey(input: AWS.Transfer.DescribeHostKeyRequest, options: SdkCallOptions): Promise; /** * Returns the details of the profile that's specified by the ProfileId. */ describeProfile(input: AWS.Transfer.DescribeProfileRequest, options: SdkCallOptions): Promise; /** * Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies. */ describeSecurityPolicy(input: AWS.Transfer.DescribeSecurityPolicyRequest, options: SdkCallOptions): Promise; /** * Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter. The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails. */ describeServer(input: AWS.Transfer.DescribeServerRequest, options: SdkCallOptions): Promise; /** * Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property. The response from this call returns the properties of the user associated with the ServerId value that was specified. */ describeUser(input: AWS.Transfer.DescribeUserRequest, options: SdkCallOptions): Promise; /** * Describes the specified workflow. */ describeWorkflow(input: AWS.Transfer.DescribeWorkflowRequest, options: SdkCallOptions): Promise; /** * Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles. */ importCertificate(input: AWS.Transfer.ImportCertificateRequest, options: SdkCallOptions): Promise; /** * Adds a host key to the server specified by the ServerId parameter. */ importHostKey(input: AWS.Transfer.ImportHostKeyRequest, options: SdkCallOptions): Promise; /** * Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId. */ importSshPublicKey(input: AWS.Transfer.ImportSshPublicKeyRequest, options: SdkCallOptions): Promise; /** * Lists the details for all the accesses you have on your server. */ listAccesses(input: AWS.Transfer.ListAccessesRequest, options: SdkCallOptions): Promise; /** * Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off. */ listAgreements(input: AWS.Transfer.ListAgreementsRequest, options: SdkCallOptions): Promise; /** * Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off. */ listCertificates(input: AWS.Transfer.ListCertificatesRequest, options: SdkCallOptions): Promise; /** * Lists the connectors for the specified Region. */ listConnectors(input: AWS.Transfer.ListConnectorsRequest, options: SdkCallOptions): Promise; /** * Lists all executions for the specified workflow. */ listExecutions(input: AWS.Transfer.ListExecutionsRequest, options: SdkCallOptions): Promise; /** * Returns a list of host keys for the server specified by the ServerId paramter. */ listHostKeys(input: AWS.Transfer.ListHostKeysRequest, options: SdkCallOptions): Promise; /** * Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off. */ listProfiles(input: AWS.Transfer.ListProfilesRequest, options: SdkCallOptions): Promise; /** * Lists the security policies that are attached to your file transfer protocol-enabled servers. */ listSecurityPolicies(input: AWS.Transfer.ListSecurityPoliciesRequest, options: SdkCallOptions): Promise; /** * Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account. */ listServers(input: AWS.Transfer.ListServersRequest, options: SdkCallOptions): Promise; /** * Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. */ listTagsForResource(input: AWS.Transfer.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter. */ listUsers(input: AWS.Transfer.ListUsersRequest, options: SdkCallOptions): Promise; /** * Lists all of your workflows. */ listWorkflows(input: AWS.Transfer.ListWorkflowsRequest, options: SdkCallOptions): Promise; /** * Sends a callback for asynchronous custom steps. The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status. */ sendWorkflowStepState(input: AWS.Transfer.SendWorkflowStepStateRequest, options: SdkCallOptions): Promise; /** * Begins an outbound file transfer. You specify the ConnectorId and the file paths for where to send the files. */ startFileTransfer(input: AWS.Transfer.StartFileTransferRequest, options: SdkCallOptions): Promise; /** * Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs. The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition. No response is returned from this call. */ startServer(input: AWS.Transfer.StartServerRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed. The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition. No response is returned from this call. */ stopServer(input: AWS.Transfer.StopServerRequest, options: SdkCallOptions): Promise<{}>; /** * Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. There is no response returned from this call. */ tagResource(input: AWS.Transfer.TagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service. The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional. You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED. If you provide any incorrect values for any parameters, the Response field is empty. If you provide a server ID for a server that uses service-managed users, you get an error: An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error: An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server */ testIdentityProvider(input: AWS.Transfer.TestIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call. */ untagResource(input: AWS.Transfer.UntagResourceRequest, options: SdkCallOptions): Promise<{}>; /** * Allows you to update parameters for the access specified in the ServerID and ExternalID parameters. */ updateAccess(input: AWS.Transfer.UpdateAccessRequest, options: SdkCallOptions): Promise; /** * Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update. */ updateAgreement(input: AWS.Transfer.UpdateAgreementRequest, options: SdkCallOptions): Promise; /** * Updates the active and inactive dates for a certificate. */ updateCertificate(input: AWS.Transfer.UpdateCertificateRequest, options: SdkCallOptions): Promise; /** * Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update. */ updateConnector(input: AWS.Transfer.UpdateConnectorRequest, options: SdkCallOptions): Promise; /** * Updates the description for the host key specified by the specified by the ServerId and HostKeyId parameters. */ updateHostKey(input: AWS.Transfer.UpdateHostKeyRequest, options: SdkCallOptions): Promise; /** * Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update. */ updateProfile(input: AWS.Transfer.UpdateProfileRequest, options: SdkCallOptions): Promise; /** * Updates the file transfer protocol-enabled server's properties after that server has been created. The UpdateServer call returns the ServerId of the server you updated. */ updateServer(input: AWS.Transfer.UpdateServerRequest, options: SdkCallOptions): Promise; /** * Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify. The response returns the ServerId and the UserName for the updated user. */ updateUser(input: AWS.Transfer.UpdateUserRequest, options: SdkCallOptions): Promise; } export interface Translate { /** * Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel data files contain examples that show how you want segments of text to be translated. By adding parallel data, you can influence the style, tone, and word choice in your translation output. */ createParallelData(input: AWS.Translate.CreateParallelDataRequest, options: SdkCallOptions): Promise; /** * Deletes a parallel data resource in Amazon Translate. */ deleteParallelData(input: AWS.Translate.DeleteParallelDataRequest, options: SdkCallOptions): Promise; /** * A synchronous action that deletes a custom terminology. */ deleteTerminology(input: AWS.Translate.DeleteTerminologyRequest, options: SdkCallOptions): Promise<{}>; /** * Gets the properties associated with an asynchronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on. */ describeTextTranslationJob(input: AWS.Translate.DescribeTextTranslationJobRequest, options: SdkCallOptions): Promise; /** * Provides information about a parallel data resource. */ getParallelData(input: AWS.Translate.GetParallelDataRequest, options: SdkCallOptions): Promise; /** * Retrieves a custom terminology. */ getTerminology(input: AWS.Translate.GetTerminologyRequest, options: SdkCallOptions): Promise; /** * Creates or updates a custom terminology, depending on whether one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. The only supported merge strategy is OVERWRITE, where the imported terminology overwrites the existing terminology of the same name. If you import a terminology that overwrites an existing one, the new terminology takes up to 10 minutes to fully propagate. After that, translations have access to the new terminology. */ importTerminology(input: AWS.Translate.ImportTerminologyRequest, options: SdkCallOptions): Promise; /** * Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports. */ listLanguages(input: AWS.Translate.ListLanguagesRequest, options: SdkCallOptions): Promise; /** * Provides a list of your parallel data resources in Amazon Translate. */ listParallelData(input: AWS.Translate.ListParallelDataRequest, options: SdkCallOptions): Promise; listTagsForResource(input: AWS.Translate.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Provides a list of custom terminologies associated with your account. */ listTerminologies(input: AWS.Translate.ListTerminologiesRequest, options: SdkCallOptions): Promise; /** * Gets a list of the batch translation jobs that you have submitted. */ listTextTranslationJobs(input: AWS.Translate.ListTextTranslationJobsRequest, options: SdkCallOptions): Promise; /** * Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async. Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation. Amazon Translate does not support batch translation of multiple source languages at once. */ startTextTranslationJob(input: AWS.Translate.StartTextTranslationJobRequest, options: SdkCallOptions): Promise; /** * Stops an asynchronous batch translation job that is in progress. If the job's state is IN_PROGRESS, the job will be marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state. Otherwise, the job is put into the STOPPED state. Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job's JobId. */ stopTextTranslationJob(input: AWS.Translate.StopTextTranslationJobRequest, options: SdkCallOptions): Promise; tagResource(input: AWS.Translate.TagResourceRequest, options: SdkCallOptions): Promise; /** * Translates input text from the source language to the target language. For a list of available languages and language codes, see what-is-languages. */ translateText(input: AWS.Translate.TranslateTextRequest, options: SdkCallOptions): Promise; untagResource(input: AWS.Translate.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a previously created parallel data resource by importing a new input file from Amazon S3. */ updateParallelData(input: AWS.Translate.UpdateParallelDataRequest, options: SdkCallOptions): Promise; } export interface VoiceID { /** * Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. */ createDomain(input: AWS.VoiceID.CreateDomainRequest, options: SdkCallOptions): Promise; /** * Deletes the specified domain from Voice ID. */ deleteDomain(input: AWS.VoiceID.DeleteDomainRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified fraudster from Voice ID. */ deleteFraudster(input: AWS.VoiceID.DeleteFraudsterRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified speaker from Voice ID. */ deleteSpeaker(input: AWS.VoiceID.DeleteSpeakerRequest, options: SdkCallOptions): Promise<{}>; /** * Describes the specified domain. */ describeDomain(input: AWS.VoiceID.DescribeDomainRequest, options: SdkCallOptions): Promise; /** * Describes the specified fraudster. */ describeFraudster(input: AWS.VoiceID.DescribeFraudsterRequest, options: SdkCallOptions): Promise; /** * Describes the specified fraudster registration job. */ describeFraudsterRegistrationJob(input: AWS.VoiceID.DescribeFraudsterRegistrationJobRequest, options: SdkCallOptions): Promise; /** * Describes the specified speaker. */ describeSpeaker(input: AWS.VoiceID.DescribeSpeakerRequest, options: SdkCallOptions): Promise; /** * Describes the specified speaker enrollment job. */ describeSpeakerEnrollmentJob(input: AWS.VoiceID.DescribeSpeakerEnrollmentJobRequest, options: SdkCallOptions): Promise; /** * Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call. */ evaluateSession(input: AWS.VoiceID.EvaluateSessionRequest, options: SdkCallOptions): Promise; /** * Lists all the domains in the Amazon Web Services account. */ listDomains(input: AWS.VoiceID.ListDomainsRequest, options: SdkCallOptions): Promise; /** * Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain. */ listFraudsterRegistrationJobs(input: AWS.VoiceID.ListFraudsterRegistrationJobsRequest, options: SdkCallOptions): Promise; /** * Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses. */ listSpeakerEnrollmentJobs(input: AWS.VoiceID.ListSpeakerEnrollmentJobsRequest, options: SdkCallOptions): Promise; /** * Lists all speakers in a specified domain. */ listSpeakers(input: AWS.VoiceID.ListSpeakersRequest, options: SdkCallOptions): Promise; /** * Lists all tags associated with a specified Voice ID resource. */ listTagsForResource(input: AWS.VoiceID.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID. */ optOutSpeaker(input: AWS.VoiceID.OptOutSpeakerRequest, options: SdkCallOptions): Promise; /** * Starts a new batch fraudster registration job using provided details. */ startFraudsterRegistrationJob(input: AWS.VoiceID.StartFraudsterRegistrationJobRequest, options: SdkCallOptions): Promise; /** * Starts a new batch speaker enrollment job using specified details. */ startSpeakerEnrollmentJob(input: AWS.VoiceID.StartSpeakerEnrollmentJobRequest, options: SdkCallOptions): Promise; /** * Tags a Voice ID resource with the provided list of tags. */ tagResource(input: AWS.VoiceID.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes specified tags from a specified Amazon Connect Voice ID resource. */ untagResource(input: AWS.VoiceID.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain. */ updateDomain(input: AWS.VoiceID.UpdateDomainRequest, options: SdkCallOptions): Promise; } export interface WAF { /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createByteMatchSet(input: AWS.WAF.CreateByteMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createGeoMatchSet(input: AWS.WAF.CreateGeoMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createIPSet(input: AWS.WAF.CreateIPSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRateBasedRule(input: AWS.WAF.CreateRateBasedRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRegexMatchSet(input: AWS.WAF.CreateRegexMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRegexPatternSet(input: AWS.WAF.CreateRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRule(input: AWS.WAF.CreateRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRuleGroup(input: AWS.WAF.CreateRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createSizeConstraintSet(input: AWS.WAF.CreateSizeConstraintSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createSqlInjectionMatchSet(input: AWS.WAF.CreateSqlInjectionMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide. */ createWebACL(input: AWS.WAF.CreateWebACLRequest, options: SdkCallOptions): Promise; /** * Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF. This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide. */ createWebACLMigrationStack(input: AWS.WAF.CreateWebACLMigrationStackRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createXssMatchSet(input: AWS.WAF.CreateXssMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request. */ deleteByteMatchSet(input: AWS.WAF.DeleteByteMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request. */ deleteGeoMatchSet(input: AWS.WAF.DeleteGeoMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request. */ deleteIPSet(input: AWS.WAF.DeleteIPSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes the LoggingConfiguration from the specified web ACL. */ deleteLoggingConfiguration(input: AWS.WAF.DeleteLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup. */ deletePermissionPolicy(input: AWS.WAF.DeletePermissionPolicyRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request. */ deleteRateBasedRule(input: AWS.WAF.DeleteRateBasedRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request. */ deleteRegexMatchSet(input: AWS.WAF.DeleteRegexMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty. */ deleteRegexPatternSet(input: AWS.WAF.DeleteRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request. */ deleteRule(input: AWS.WAF.DeleteRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request. */ deleteRuleGroup(input: AWS.WAF.DeleteRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request. */ deleteSizeConstraintSet(input: AWS.WAF.DeleteSizeConstraintSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request. */ deleteSqlInjectionMatchSet(input: AWS.WAF.DeleteSqlInjectionMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request. */ deleteWebACL(input: AWS.WAF.DeleteWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request. */ deleteXssMatchSet(input: AWS.WAF.DeleteXssMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the ByteMatchSet specified by ByteMatchSetId. */ getByteMatchSet(input: AWS.WAF.GetByteMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token. */ getChangeToken(input: AWS.WAF.GetChangeTokenRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete. */ getChangeTokenStatus(input: AWS.WAF.GetChangeTokenStatusRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the GeoMatchSet that is specified by GeoMatchSetId. */ getGeoMatchSet(input: AWS.WAF.GetGeoMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the IPSet that is specified by IPSetId. */ getIPSet(input: AWS.WAF.GetIPSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the LoggingConfiguration for the specified web ACL. */ getLoggingConfiguration(input: AWS.WAF.GetLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the IAM policy attached to the RuleGroup. */ getPermissionPolicy(input: AWS.WAF.GetPermissionPolicyRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request. */ getRateBasedRule(input: AWS.WAF.GetRateBasedRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked. */ getRateBasedRuleManagedKeys(input: AWS.WAF.GetRateBasedRuleManagedKeysRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the RegexMatchSet specified by RegexMatchSetId. */ getRegexMatchSet(input: AWS.WAF.GetRegexMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the RegexPatternSet specified by RegexPatternSetId. */ getRegexPatternSet(input: AWS.WAF.GetRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the Rule that is specified by the RuleId that you included in the GetRule request. */ getRule(input: AWS.WAF.GetRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup. */ getRuleGroup(input: AWS.WAF.GetRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. */ getSampledRequests(input: AWS.WAF.GetSampledRequestsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the SizeConstraintSet specified by SizeConstraintSetId. */ getSizeConstraintSet(input: AWS.WAF.GetSizeConstraintSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId. */ getSqlInjectionMatchSet(input: AWS.WAF.GetSqlInjectionMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the WebACL that is specified by WebACLId. */ getWebACL(input: AWS.WAF.GetWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the XssMatchSet that is specified by XssMatchSetId. */ getXssMatchSet(input: AWS.WAF.GetXssMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of ActivatedRule objects. */ listActivatedRulesInRuleGroup(input: AWS.WAF.ListActivatedRulesInRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of ByteMatchSetSummary objects. */ listByteMatchSets(input: AWS.WAF.ListByteMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of GeoMatchSetSummary objects in the response. */ listGeoMatchSets(input: AWS.WAF.ListGeoMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of IPSetSummary objects in the response. */ listIPSets(input: AWS.WAF.ListIPSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of LoggingConfiguration objects. */ listLoggingConfigurations(input: AWS.WAF.ListLoggingConfigurationsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleSummary objects. */ listRateBasedRules(input: AWS.WAF.ListRateBasedRulesRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RegexMatchSetSummary objects. */ listRegexMatchSets(input: AWS.WAF.ListRegexMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RegexPatternSetSummary objects. */ listRegexPatternSets(input: AWS.WAF.ListRegexPatternSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleGroup objects. */ listRuleGroups(input: AWS.WAF.ListRuleGroupsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleSummary objects. */ listRules(input: AWS.WAF.ListRulesRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of SizeConstraintSetSummary objects. */ listSizeConstraintSets(input: AWS.WAF.ListSizeConstraintSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of SqlInjectionMatchSet objects. */ listSqlInjectionMatchSets(input: AWS.WAF.ListSqlInjectionMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleGroup objects that you are subscribed to. */ listSubscribedRuleGroups(input: AWS.WAF.ListSubscribedRuleGroupsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. */ listTagsForResource(input: AWS.WAF.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of WebACLSummary objects in the response. */ listWebACLs(input: AWS.WAF.ListWebACLsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of XssMatchSet objects. */ listXssMatchSets(input: AWS.WAF.ListXssMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Do not create the data firehose using a Kinesis stream as your source. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide. */ putLoggingConfiguration(input: AWS.WAF.PutLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below. */ putPermissionPolicy(input: AWS.WAF.PutPermissionPolicyRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. */ tagResource(input: AWS.WAF.TagResourceRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. */ untagResource(input: AWS.WAF.UntagResourceRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateByteMatchSet(input: AWS.WAF.UpdateByteMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateGeoMatchSet(input: AWS.WAF.UpdateGeoMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateIPSet(input: AWS.WAF.UpdateIPSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. */ updateRateBasedRule(input: AWS.WAF.UpdateRateBasedRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateRegexMatchSet(input: AWS.WAF.UpdateRegexMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateRegexPatternSet(input: AWS.WAF.UpdateRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateRule(input: AWS.WAF.UpdateRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateRuleGroup(input: AWS.WAF.UpdateRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateSizeConstraintSet(input: AWS.WAF.UpdateSizeConstraintSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateSqlInjectionMatchSet(input: AWS.WAF.UpdateSqlInjectionMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule , you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules . Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateWebACL(input: AWS.WAF.UpdateWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateXssMatchSet(input: AWS.WAF.UpdateXssMatchSetRequest, options: SdkCallOptions): Promise; } export interface WAFRegional { /** * This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage. */ associateWebACL(input: AWS.WAFRegional.AssociateWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createByteMatchSet(input: AWS.WAFRegional.CreateByteMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createGeoMatchSet(input: AWS.WAFRegional.CreateGeoMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createIPSet(input: AWS.WAFRegional.CreateIPSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRateBasedRule(input: AWS.WAFRegional.CreateRateBasedRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRegexMatchSet(input: AWS.WAFRegional.CreateRegexMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRegexPatternSet(input: AWS.WAFRegional.CreateRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRule(input: AWS.WAFRegional.CreateRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createRuleGroup(input: AWS.WAFRegional.CreateRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createSizeConstraintSet(input: AWS.WAFRegional.CreateSizeConstraintSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createSqlInjectionMatchSet(input: AWS.WAFRegional.CreateSqlInjectionMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide. */ createWebACL(input: AWS.WAFRegional.CreateWebACLRequest, options: SdkCallOptions): Promise; /** * Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF. This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide. */ createWebACLMigrationStack(input: AWS.WAFRegional.CreateWebACLMigrationStackRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ createXssMatchSet(input: AWS.WAFRegional.CreateXssMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request. */ deleteByteMatchSet(input: AWS.WAFRegional.DeleteByteMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request. */ deleteGeoMatchSet(input: AWS.WAFRegional.DeleteGeoMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request. */ deleteIPSet(input: AWS.WAFRegional.DeleteIPSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes the LoggingConfiguration from the specified web ACL. */ deleteLoggingConfiguration(input: AWS.WAFRegional.DeleteLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup. */ deletePermissionPolicy(input: AWS.WAFRegional.DeletePermissionPolicyRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request. */ deleteRateBasedRule(input: AWS.WAFRegional.DeleteRateBasedRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request. */ deleteRegexMatchSet(input: AWS.WAFRegional.DeleteRegexMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty. */ deleteRegexPatternSet(input: AWS.WAFRegional.DeleteRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request. */ deleteRule(input: AWS.WAFRegional.DeleteRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request. */ deleteRuleGroup(input: AWS.WAFRegional.DeleteRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request. */ deleteSizeConstraintSet(input: AWS.WAFRegional.DeleteSizeConstraintSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request. */ deleteSqlInjectionMatchSet(input: AWS.WAFRegional.DeleteSqlInjectionMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request. */ deleteWebACL(input: AWS.WAFRegional.DeleteWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request. */ deleteXssMatchSet(input: AWS.WAFRegional.DeleteXssMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage. */ disassociateWebACL(input: AWS.WAFRegional.DisassociateWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the ByteMatchSet specified by ByteMatchSetId. */ getByteMatchSet(input: AWS.WAFRegional.GetByteMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token. */ getChangeToken(input: AWS.WAFRegional.GetChangeTokenRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete. */ getChangeTokenStatus(input: AWS.WAFRegional.GetChangeTokenStatusRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the GeoMatchSet that is specified by GeoMatchSetId. */ getGeoMatchSet(input: AWS.WAFRegional.GetGeoMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the IPSet that is specified by IPSetId. */ getIPSet(input: AWS.WAFRegional.GetIPSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the LoggingConfiguration for the specified web ACL. */ getLoggingConfiguration(input: AWS.WAFRegional.GetLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the IAM policy attached to the RuleGroup. */ getPermissionPolicy(input: AWS.WAFRegional.GetPermissionPolicyRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request. */ getRateBasedRule(input: AWS.WAFRegional.GetRateBasedRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked. */ getRateBasedRuleManagedKeys(input: AWS.WAFRegional.GetRateBasedRuleManagedKeysRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the RegexMatchSet specified by RegexMatchSetId. */ getRegexMatchSet(input: AWS.WAFRegional.GetRegexMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the RegexPatternSet specified by RegexPatternSetId. */ getRegexPatternSet(input: AWS.WAFRegional.GetRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the Rule that is specified by the RuleId that you included in the GetRule request. */ getRule(input: AWS.WAFRegional.GetRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup. */ getRuleGroup(input: AWS.WAFRegional.GetRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. */ getSampledRequests(input: AWS.WAFRegional.GetSampledRequestsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the SizeConstraintSet specified by SizeConstraintSetId. */ getSizeConstraintSet(input: AWS.WAFRegional.GetSizeConstraintSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId. */ getSqlInjectionMatchSet(input: AWS.WAFRegional.GetSqlInjectionMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the WebACL that is specified by WebACLId. */ getWebACL(input: AWS.WAFRegional.GetWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage. */ getWebACLForResource(input: AWS.WAFRegional.GetWebACLForResourceRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the XssMatchSet that is specified by XssMatchSetId. */ getXssMatchSet(input: AWS.WAFRegional.GetXssMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of ActivatedRule objects. */ listActivatedRulesInRuleGroup(input: AWS.WAFRegional.ListActivatedRulesInRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of ByteMatchSetSummary objects. */ listByteMatchSets(input: AWS.WAFRegional.ListByteMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of GeoMatchSetSummary objects in the response. */ listGeoMatchSets(input: AWS.WAFRegional.ListGeoMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of IPSetSummary objects in the response. */ listIPSets(input: AWS.WAFRegional.ListIPSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of LoggingConfiguration objects. */ listLoggingConfigurations(input: AWS.WAFRegional.ListLoggingConfigurationsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleSummary objects. */ listRateBasedRules(input: AWS.WAFRegional.ListRateBasedRulesRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RegexMatchSetSummary objects. */ listRegexMatchSets(input: AWS.WAFRegional.ListRegexMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RegexPatternSetSummary objects. */ listRegexPatternSets(input: AWS.WAFRegional.ListRegexPatternSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of resources associated with the specified web ACL. */ listResourcesForWebACL(input: AWS.WAFRegional.ListResourcesForWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleGroup objects. */ listRuleGroups(input: AWS.WAFRegional.ListRuleGroupsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleSummary objects. */ listRules(input: AWS.WAFRegional.ListRulesRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of SizeConstraintSetSummary objects. */ listSizeConstraintSets(input: AWS.WAFRegional.ListSizeConstraintSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of SqlInjectionMatchSet objects. */ listSqlInjectionMatchSets(input: AWS.WAFRegional.ListSqlInjectionMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleGroup objects that you are subscribed to. */ listSubscribedRuleGroups(input: AWS.WAFRegional.ListSubscribedRuleGroupsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. */ listTagsForResource(input: AWS.WAFRegional.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of WebACLSummary objects in the response. */ listWebACLs(input: AWS.WAFRegional.ListWebACLsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of XssMatchSet objects. */ listXssMatchSets(input: AWS.WAFRegional.ListXssMatchSetsRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Do not create the data firehose using a Kinesis stream as your source. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide. */ putLoggingConfiguration(input: AWS.WAFRegional.PutLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below. */ putPermissionPolicy(input: AWS.WAFRegional.PutPermissionPolicyRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. */ tagResource(input: AWS.WAFRegional.TagResourceRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. */ untagResource(input: AWS.WAFRegional.UntagResourceRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateByteMatchSet(input: AWS.WAFRegional.UpdateByteMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateGeoMatchSet(input: AWS.WAFRegional.UpdateGeoMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateIPSet(input: AWS.WAFRegional.UpdateIPSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. */ updateRateBasedRule(input: AWS.WAFRegional.UpdateRateBasedRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateRegexMatchSet(input: AWS.WAFRegional.UpdateRegexMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateRegexPatternSet(input: AWS.WAFRegional.UpdateRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateRule(input: AWS.WAFRegional.UpdateRuleRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateRuleGroup(input: AWS.WAFRegional.UpdateRuleGroupRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateSizeConstraintSet(input: AWS.WAFRegional.UpdateSizeConstraintSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateSqlInjectionMatchSet(input: AWS.WAFRegional.UpdateSqlInjectionMatchSetRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule , you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules . Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateWebACL(input: AWS.WAFRegional.UpdateWebACLRequest, options: SdkCallOptions): Promise; /** * This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. */ updateXssMatchSet(input: AWS.WAFRegional.UpdateXssMatchSetRequest, options: SdkCallOptions): Promise; } export interface WAFV2 { /** * Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool. For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution. When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. */ associateWebACL(input: AWS.WAFV2.AssociateWebACLRequest, options: SdkCallOptions): Promise; /** * Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL. WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500. */ checkCapacity(input: AWS.WAFV2.CheckCapacityRequest, options: SdkCallOptions): Promise; /** * Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses. */ createIPSet(input: AWS.WAFV2.CreateIPSetRequest, options: SdkCallOptions): Promise; /** * Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns. */ createRegexPatternSet(input: AWS.WAFV2.CreateRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * Creates a RuleGroup per the specifications provided. A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. */ createRuleGroup(input: AWS.WAFV2.CreateRuleGroupRequest, options: SdkCallOptions): Promise; /** * Creates a WebACL per the specifications provided. A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool. */ createWebACL(input: AWS.WAFV2.CreateWebACLRequest, options: SdkCallOptions): Promise; /** * Deletes all rule groups that are managed by Firewall Manager for the specified web ACL. You can only use this if ManagedByFirewallManager is false in the specified WebACL. */ deleteFirewallManagerRuleGroups(input: AWS.WAFV2.DeleteFirewallManagerRuleGroupsRequest, options: SdkCallOptions): Promise; /** * Deletes the specified IPSet. */ deleteIPSet(input: AWS.WAFV2.DeleteIPSetRequest, options: SdkCallOptions): Promise; /** * Deletes the LoggingConfiguration from the specified web ACL. */ deleteLoggingConfiguration(input: AWS.WAFV2.DeleteLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Permanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation. */ deletePermissionPolicy(input: AWS.WAFV2.DeletePermissionPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes the specified RegexPatternSet. */ deleteRegexPatternSet(input: AWS.WAFV2.DeleteRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * Deletes the specified RuleGroup. */ deleteRuleGroup(input: AWS.WAFV2.DeleteRuleGroupRequest, options: SdkCallOptions): Promise; /** * Deletes the specified WebACL. You can only use this if ManagedByFirewallManager is false in the specified WebACL. Before deleting any web ACL, first disassociate it from all resources. To retrieve a list of the resources that are associated with a web ACL, use the following calls: For regional resources, call ListResourcesForWebACL. For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId. To disassociate a resource from a web ACL, use the following calls: For regional resources, call DisassociateWebACL. For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution. */ deleteWebACL(input: AWS.WAFV2.DeleteWebACLRequest, options: SdkCallOptions): Promise; /** * Provides high-level information for a managed rule group, including descriptions of the rules. */ describeManagedRuleGroup(input: AWS.WAFV2.DescribeManagedRuleGroupRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool. For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution. */ disassociateWebACL(input: AWS.WAFV2.DisassociateWebACLRequest, options: SdkCallOptions): Promise; /** * Generates a presigned download URL for the specified release of the mobile SDK. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide. */ generateMobileSdkReleaseUrl(input: AWS.WAFV2.GenerateMobileSdkReleaseUrlRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified IPSet. */ getIPSet(input: AWS.WAFV2.GetIPSetRequest, options: SdkCallOptions): Promise; /** * Returns the LoggingConfiguration for the specified web ACL. */ getLoggingConfiguration(input: AWS.WAFV2.GetLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified managed rule set. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. */ getManagedRuleSet(input: AWS.WAFV2.GetManagedRuleSetRequest, options: SdkCallOptions): Promise; /** * Retrieves information for the specified mobile SDK release, including release notes and tags. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide. */ getMobileSdkRelease(input: AWS.WAFV2.GetMobileSdkReleaseRequest, options: SdkCallOptions): Promise; /** * Returns the IAM policy that is attached to the specified rule group. You must be the owner of the rule group to perform this operation. */ getPermissionPolicy(input: AWS.WAFV2.GetPermissionPolicyRequest, options: SdkCallOptions): Promise; /** * Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first. */ getRateBasedStatementManagedKeys(input: AWS.WAFV2.GetRateBasedStatementManagedKeysRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified RegexPatternSet. */ getRegexPatternSet(input: AWS.WAFV2.GetRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified RuleGroup. */ getRuleGroup(input: AWS.WAFV2.GetRuleGroupRequest, options: SdkCallOptions): Promise; /** * Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample. */ getSampledRequests(input: AWS.WAFV2.GetSampledRequestsRequest, options: SdkCallOptions): Promise; /** * Retrieves the specified WebACL. */ getWebACL(input: AWS.WAFV2.GetWebACLRequest, options: SdkCallOptions): Promise; /** * Retrieves the WebACL for the specified resource. */ getWebACLForResource(input: AWS.WAFV2.GetWebACLForResourceRequest, options: SdkCallOptions): Promise; /** * Returns a list of the available versions for the specified managed rule group. */ listAvailableManagedRuleGroupVersions(input: AWS.WAFV2.ListAvailableManagedRuleGroupVersionsRequest, options: SdkCallOptions): Promise; /** * Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to. */ listAvailableManagedRuleGroups(input: AWS.WAFV2.ListAvailableManagedRuleGroupsRequest, options: SdkCallOptions): Promise; /** * Retrieves an array of IPSetSummary objects for the IP sets that you manage. */ listIPSets(input: AWS.WAFV2.ListIPSetsRequest, options: SdkCallOptions): Promise; /** * Retrieves an array of your LoggingConfiguration objects. */ listLoggingConfigurations(input: AWS.WAFV2.ListLoggingConfigurationsRequest, options: SdkCallOptions): Promise; /** * Retrieves the managed rule sets that you own. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. */ listManagedRuleSets(input: AWS.WAFV2.ListManagedRuleSetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of the available releases for the mobile SDK and the specified device platform. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide. */ listMobileSdkReleases(input: AWS.WAFV2.ListMobileSdkReleasesRequest, options: SdkCallOptions): Promise; /** * Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage. */ listRegexPatternSets(input: AWS.WAFV2.ListRegexPatternSetsRequest, options: SdkCallOptions): Promise; /** * Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use the CloudFront call ListDistributionsByWebACLId. */ listResourcesForWebACL(input: AWS.WAFV2.ListResourcesForWebACLRequest, options: SdkCallOptions): Promise; /** * Retrieves an array of RuleGroupSummary objects for the rule groups that you manage. */ listRuleGroups(input: AWS.WAFV2.ListRuleGroupsRequest, options: SdkCallOptions): Promise; /** * Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource. You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console. */ listTagsForResource(input: AWS.WAFV2.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves an array of WebACLSummary objects for the web ACLs that you manage. */ listWebACLs(input: AWS.WAFV2.ListWebACLsRequest, options: SdkCallOptions): Promise; /** * Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided. You can define one logging destination per web ACL. You can access information about the traffic that WAF inspects using the following steps: Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. For information about configuring logging destinations and the permissions that are required for each, see Logging web ACL traffic information in the WAF Developer Guide. Associate your logging destination to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role. For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide. This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call. */ putLoggingConfiguration(input: AWS.WAFV2.PutLoggingConfigurationRequest, options: SdkCallOptions): Promise; /** * Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using. To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate. */ putManagedRuleSetVersions(input: AWS.WAFV2.PutManagedRuleSetVersionsRequest, options: SdkCallOptions): Promise; /** * Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts. You must be the owner of the rule group to perform this operation. This action is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region. The user making the request must be the owner of the rule group. */ putPermissionPolicy(input: AWS.WAFV2.PutPermissionPolicyRequest, options: SdkCallOptions): Promise; /** * Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource. You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console. */ tagResource(input: AWS.WAFV2.TagResourceRequest, options: SdkCallOptions): Promise; /** * Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource. */ untagResource(input: AWS.WAFV2.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the specified IPSet. This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call. When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. */ updateIPSet(input: AWS.WAFV2.UpdateIPSetRequest, options: SdkCallOptions): Promise; /** * Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. */ updateManagedRuleSetVersionExpiryDate(input: AWS.WAFV2.UpdateManagedRuleSetVersionExpiryDateRequest, options: SdkCallOptions): Promise; /** * Updates the specified RegexPatternSet. This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call. When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. */ updateRegexPatternSet(input: AWS.WAFV2.UpdateRegexPatternSetRequest, options: SdkCallOptions): Promise; /** * Updates the specified RuleGroup. This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call. When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. */ updateRuleGroup(input: AWS.WAFV2.UpdateRuleGroupRequest, options: SdkCallOptions): Promise; /** * Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call. A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool. */ updateWebACL(input: AWS.WAFV2.UpdateWebACLRequest, options: SdkCallOptions): Promise; } export interface WellArchitected { /** * Associate a lens to a workload. Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload. Disclaimer By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement. */ associateLenses(input: AWS.WellArchitected.AssociateLensesInput, options: SdkCallOptions): Promise<{}>; /** * Create a lens share. The owner of a lens can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted. Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. */ createLensShare(input: AWS.WellArchitected.CreateLensShareInput, options: SdkCallOptions): Promise; /** * Create a new lens version. A lens can have up to 100 versions. After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it. */ createLensVersion(input: AWS.WellArchitected.CreateLensVersionInput, options: SdkCallOptions): Promise; /** * Create a milestone for an existing workload. */ createMilestone(input: AWS.WellArchitected.CreateMilestoneInput, options: SdkCallOptions): Promise; /** * Create a new workload. The owner of a workload can share the workload with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a workload can delete it. For more information, see Defining a Workload in the Well-Architected Tool User Guide. */ createWorkload(input: AWS.WellArchitected.CreateWorkloadInput, options: SdkCallOptions): Promise; /** * Create a workload share. The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted. For more information, see Sharing a Workload in the Well-Architected Tool User Guide. */ createWorkloadShare(input: AWS.WellArchitected.CreateWorkloadShareInput, options: SdkCallOptions): Promise; /** * Delete an existing lens. Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads. Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. */ deleteLens(input: AWS.WellArchitected.DeleteLensInput, options: SdkCallOptions): Promise<{}>; /** * Delete a lens share. After the lens share is deleted, Amazon Web Services accounts and IAM users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads. Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. */ deleteLensShare(input: AWS.WellArchitected.DeleteLensShareInput, options: SdkCallOptions): Promise<{}>; /** * Delete an existing workload. */ deleteWorkload(input: AWS.WellArchitected.DeleteWorkloadInput, options: SdkCallOptions): Promise<{}>; /** * Delete a workload share. */ deleteWorkloadShare(input: AWS.WellArchitected.DeleteWorkloadShareInput, options: SdkCallOptions): Promise<{}>; /** * Disassociate a lens from a workload. Up to 10 lenses can be disassociated from a workload in a single API operation. The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload. */ disassociateLenses(input: AWS.WellArchitected.DisassociateLensesInput, options: SdkCallOptions): Promise<{}>; /** * Export an existing lens. Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. Only the owner of a lens can export it. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data. */ exportLens(input: AWS.WellArchitected.ExportLensInput, options: SdkCallOptions): Promise; /** * Get the answer to a specific question in a workload review. */ getAnswer(input: AWS.WellArchitected.GetAnswerInput, options: SdkCallOptions): Promise; /** * Get an existing lens. */ getLens(input: AWS.WellArchitected.GetLensInput, options: SdkCallOptions): Promise; /** * Get lens review. */ getLensReview(input: AWS.WellArchitected.GetLensReviewInput, options: SdkCallOptions): Promise; /** * Get lens review report. */ getLensReviewReport(input: AWS.WellArchitected.GetLensReviewReportInput, options: SdkCallOptions): Promise; /** * Get lens version differences. */ getLensVersionDifference(input: AWS.WellArchitected.GetLensVersionDifferenceInput, options: SdkCallOptions): Promise; /** * Get a milestone for an existing workload. */ getMilestone(input: AWS.WellArchitected.GetMilestoneInput, options: SdkCallOptions): Promise; /** * Get an existing workload. */ getWorkload(input: AWS.WellArchitected.GetWorkloadInput, options: SdkCallOptions): Promise; /** * Import a new lens. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. A custom lens cannot exceed 500 KB in size. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data. */ importLens(input: AWS.WellArchitected.ImportLensInput, options: SdkCallOptions): Promise; /** * List of answers. */ listAnswers(input: AWS.WellArchitected.ListAnswersInput, options: SdkCallOptions): Promise; /** * List lens review improvements. */ listLensReviewImprovements(input: AWS.WellArchitected.ListLensReviewImprovementsInput, options: SdkCallOptions): Promise; /** * List lens reviews. */ listLensReviews(input: AWS.WellArchitected.ListLensReviewsInput, options: SdkCallOptions): Promise; /** * List the lens shares associated with the lens. */ listLensShares(input: AWS.WellArchitected.ListLensSharesInput, options: SdkCallOptions): Promise; /** * List the available lenses. */ listLenses(input: AWS.WellArchitected.ListLensesInput, options: SdkCallOptions): Promise; /** * List all milestones for an existing workload. */ listMilestones(input: AWS.WellArchitected.ListMilestonesInput, options: SdkCallOptions): Promise; /** * List lens notifications. */ listNotifications(input: AWS.WellArchitected.ListNotificationsInput, options: SdkCallOptions): Promise; /** * List the workload invitations. */ listShareInvitations(input: AWS.WellArchitected.ListShareInvitationsInput, options: SdkCallOptions): Promise; /** * List the tags for a resource. The WorkloadArn parameter can be either a workload ARN or a custom lens ARN. */ listTagsForResource(input: AWS.WellArchitected.ListTagsForResourceInput, options: SdkCallOptions): Promise; /** * List the workload shares associated with the workload. */ listWorkloadShares(input: AWS.WellArchitected.ListWorkloadSharesInput, options: SdkCallOptions): Promise; /** * List workloads. Paginated. */ listWorkloads(input: AWS.WellArchitected.ListWorkloadsInput, options: SdkCallOptions): Promise; /** * Adds one or more tags to the specified resource. The WorkloadArn parameter can be either a workload ARN or a custom lens ARN. */ tagResource(input: AWS.WellArchitected.TagResourceInput, options: SdkCallOptions): Promise; /** * Deletes specified tags from a resource. The WorkloadArn parameter can be either a workload ARN or a custom lens ARN. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2 */ untagResource(input: AWS.WellArchitected.UntagResourceInput, options: SdkCallOptions): Promise; /** * Update the answer to a specific question in a workload review. */ updateAnswer(input: AWS.WellArchitected.UpdateAnswerInput, options: SdkCallOptions): Promise; /** * Updates whether the Amazon Web Services account is opted into organization sharing features. */ updateGlobalSettings(input: AWS.WellArchitected.UpdateGlobalSettingsInput, options: SdkCallOptions): Promise<{}>; /** * Update lens review. */ updateLensReview(input: AWS.WellArchitected.UpdateLensReviewInput, options: SdkCallOptions): Promise; /** * Update a workload invitation. */ updateShareInvitation(input: AWS.WellArchitected.UpdateShareInvitationInput, options: SdkCallOptions): Promise; /** * Update an existing workload. */ updateWorkload(input: AWS.WellArchitected.UpdateWorkloadInput, options: SdkCallOptions): Promise; /** * Update a workload share. */ updateWorkloadShare(input: AWS.WellArchitected.UpdateWorkloadShareInput, options: SdkCallOptions): Promise; /** * Upgrade lens review. */ upgradeLensReview(input: AWS.WellArchitected.UpgradeLensReviewInput, options: SdkCallOptions): Promise<{}>; } export interface Wisdom { /** * Creates an Amazon Connect Wisdom assistant. */ createAssistant(input: AWS.Wisdom.CreateAssistantRequest, options: SdkCallOptions): Promise; /** * Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association. */ createAssistantAssociation(input: AWS.Wisdom.CreateAssistantAssociationRequest, options: SdkCallOptions): Promise; /** * Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset. */ createContent(input: AWS.Wisdom.CreateContentRequest, options: SdkCallOptions): Promise; /** * Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error. <p>For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:</p> <ol> <li> <p>Call <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note> */ createKnowledgeBase(input: AWS.Wisdom.CreateKnowledgeBaseRequest, options: SdkCallOptions): Promise; /** * Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled. */ createSession(input: AWS.Wisdom.CreateSessionRequest, options: SdkCallOptions): Promise; /** * Deletes an assistant. */ deleteAssistant(input: AWS.Wisdom.DeleteAssistantRequest, options: SdkCallOptions): Promise; /** * Deletes an assistant association. */ deleteAssistantAssociation(input: AWS.Wisdom.DeleteAssistantAssociationRequest, options: SdkCallOptions): Promise; /** * Deletes the content. */ deleteContent(input: AWS.Wisdom.DeleteContentRequest, options: SdkCallOptions): Promise; /** * Deletes the knowledge base. When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference. */ deleteKnowledgeBase(input: AWS.Wisdom.DeleteKnowledgeBaseRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an assistant. */ getAssistant(input: AWS.Wisdom.GetAssistantRequest, options: SdkCallOptions): Promise; /** * Retrieves information about an assistant association. */ getAssistantAssociation(input: AWS.Wisdom.GetAssistantAssociationRequest, options: SdkCallOptions): Promise; /** * Retrieves content, including a pre-signed URL to download the content. */ getContent(input: AWS.Wisdom.GetContentRequest, options: SdkCallOptions): Promise; /** * Retrieves summary information about the content. */ getContentSummary(input: AWS.Wisdom.GetContentSummaryRequest, options: SdkCallOptions): Promise; /** * Retrieves information about the knowledge base. */ getKnowledgeBase(input: AWS.Wisdom.GetKnowledgeBaseRequest, options: SdkCallOptions): Promise; /** * Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant. */ getRecommendations(input: AWS.Wisdom.GetRecommendationsRequest, options: SdkCallOptions): Promise; /** * Retrieves information for a specified session. */ getSession(input: AWS.Wisdom.GetSessionRequest, options: SdkCallOptions): Promise; /** * Lists information about assistant associations. */ listAssistantAssociations(input: AWS.Wisdom.ListAssistantAssociationsRequest, options: SdkCallOptions): Promise; /** * Lists information about assistants. */ listAssistants(input: AWS.Wisdom.ListAssistantsRequest, options: SdkCallOptions): Promise; /** * Lists the content. */ listContents(input: AWS.Wisdom.ListContentsRequest, options: SdkCallOptions): Promise; /** * Lists the knowledge bases. */ listKnowledgeBases(input: AWS.Wisdom.ListKnowledgeBasesRequest, options: SdkCallOptions): Promise; /** * Lists the tags for the specified resource. */ listTagsForResource(input: AWS.Wisdom.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations. */ notifyRecommendationsReceived(input: AWS.Wisdom.NotifyRecommendationsReceivedRequest, options: SdkCallOptions): Promise; /** * Submits feedback to Wisdom. The feedback is used to improve future recommendations from GetRecommendations or results from QueryAssistant. Feedback can be resubmitted up to 6 hours after submission. */ putFeedback(input: AWS.Wisdom.PutFeedbackRequest, options: SdkCallOptions): Promise; /** * Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations. */ queryAssistant(input: AWS.Wisdom.QueryAssistantRequest, options: SdkCallOptions): Promise; /** * Removes a URI template from a knowledge base. */ removeKnowledgeBaseTemplateUri(input: AWS.Wisdom.RemoveKnowledgeBaseTemplateUriRequest, options: SdkCallOptions): Promise; /** * Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name. */ searchContent(input: AWS.Wisdom.SearchContentRequest, options: SdkCallOptions): Promise; /** * Searches for sessions. */ searchSessions(input: AWS.Wisdom.SearchSessionsRequest, options: SdkCallOptions): Promise; /** * Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM. */ startContentUpload(input: AWS.Wisdom.StartContentUploadRequest, options: SdkCallOptions): Promise; /** * Adds the specified tags to the specified resource. */ tagResource(input: AWS.Wisdom.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes the specified tags from the specified resource. */ untagResource(input: AWS.Wisdom.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates information about the content. */ updateContent(input: AWS.Wisdom.UpdateContentRequest, options: SdkCallOptions): Promise; /** * Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*view. */ updateKnowledgeBaseTemplateUri(input: AWS.Wisdom.UpdateKnowledgeBaseTemplateUriRequest, options: SdkCallOptions): Promise; } export interface WorkDocs { /** * Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so. */ abortDocumentVersionUpload(input: AWS.WorkDocs.AbortDocumentVersionUploadRequest, options: SdkCallOptions): Promise<{}>; /** * Activates the specified user. Only active users can access Amazon WorkDocs. */ activateUser(input: AWS.WorkDocs.ActivateUserRequest, options: SdkCallOptions): Promise; /** * Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions. */ addResourcePermissions(input: AWS.WorkDocs.AddResourcePermissionsRequest, options: SdkCallOptions): Promise; /** * Adds a new comment to the specified document version. */ createComment(input: AWS.WorkDocs.CreateCommentRequest, options: SdkCallOptions): Promise; /** * Adds one or more custom properties to the specified resource (a folder, document, or version). */ createCustomMetadata(input: AWS.WorkDocs.CreateCustomMetadataRequest, options: SdkCallOptions): Promise; /** * Creates a folder with the specified name and parent folder. */ createFolder(input: AWS.WorkDocs.CreateFolderRequest, options: SdkCallOptions): Promise; /** * Adds the specified list of labels to the given resource (a document or folder) */ createLabels(input: AWS.WorkDocs.CreateLabelsRequest, options: SdkCallOptions): Promise; /** * Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide. */ createNotificationSubscription(input: AWS.WorkDocs.CreateNotificationSubscriptionRequest, options: SdkCallOptions): Promise; /** * Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs. */ createUser(input: AWS.WorkDocs.CreateUserRequest, options: SdkCallOptions): Promise; /** * Deactivates the specified user, which revokes the user's access to Amazon WorkDocs. */ deactivateUser(input: AWS.WorkDocs.DeactivateUserRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified comment from the document version. */ deleteComment(input: AWS.WorkDocs.DeleteCommentRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes custom metadata from the specified resource. */ deleteCustomMetadata(input: AWS.WorkDocs.DeleteCustomMetadataRequest, options: SdkCallOptions): Promise; /** * Permanently deletes the specified document and its associated metadata. */ deleteDocument(input: AWS.WorkDocs.DeleteDocumentRequest, options: SdkCallOptions): Promise<{}>; /** * Permanently deletes the specified folder and its contents. */ deleteFolder(input: AWS.WorkDocs.DeleteFolderRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the contents of the specified folder. */ deleteFolderContents(input: AWS.WorkDocs.DeleteFolderContentsRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified list of labels from a resource. */ deleteLabels(input: AWS.WorkDocs.DeleteLabelsRequest, options: SdkCallOptions): Promise; /** * Deletes the specified subscription from the specified organization. */ deleteNotificationSubscription(input: AWS.WorkDocs.DeleteNotificationSubscriptionRequest, options: SdkCallOptions): Promise<{}>; /** * Deletes the specified user from a Simple AD or Microsoft AD directory. */ deleteUser(input: AWS.WorkDocs.DeleteUserRequest, options: SdkCallOptions): Promise<{}>; /** * Describes the user activities in a specified time period. */ describeActivities(input: AWS.WorkDocs.DescribeActivitiesRequest, options: SdkCallOptions): Promise; /** * List all the comments for the specified document version. */ describeComments(input: AWS.WorkDocs.DescribeCommentsRequest, options: SdkCallOptions): Promise; /** * Retrieves the document versions for the specified document. By default, only active versions are returned. */ describeDocumentVersions(input: AWS.WorkDocs.DescribeDocumentVersionsRequest, options: SdkCallOptions): Promise; /** * Describes the contents of the specified folder, including its documents and subfolders. By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents. */ describeFolderContents(input: AWS.WorkDocs.DescribeFolderContentsRequest, options: SdkCallOptions): Promise; /** * Describes the groups specified by the query. Groups are defined by the underlying Active Directory. */ describeGroups(input: AWS.WorkDocs.DescribeGroupsRequest, options: SdkCallOptions): Promise; /** * Lists the specified notification subscriptions. */ describeNotificationSubscriptions(input: AWS.WorkDocs.DescribeNotificationSubscriptionsRequest, options: SdkCallOptions): Promise; /** * Describes the permissions of a specified resource. */ describeResourcePermissions(input: AWS.WorkDocs.DescribeResourcePermissionsRequest, options: SdkCallOptions): Promise; /** * Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide. */ describeRootFolders(input: AWS.WorkDocs.DescribeRootFoldersRequest, options: SdkCallOptions): Promise; /** * Describes the specified users. You can describe all users or filter the results (for example, by status or organization). By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results. */ describeUsers(input: AWS.WorkDocs.DescribeUsersRequest, options: SdkCallOptions): Promise; /** * Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide. */ getCurrentUser(input: AWS.WorkDocs.GetCurrentUserRequest, options: SdkCallOptions): Promise; /** * Retrieves details of a document. */ getDocument(input: AWS.WorkDocs.GetDocumentRequest, options: SdkCallOptions): Promise; /** * Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders. */ getDocumentPath(input: AWS.WorkDocs.GetDocumentPathRequest, options: SdkCallOptions): Promise; /** * Retrieves version metadata for the specified document. */ getDocumentVersion(input: AWS.WorkDocs.GetDocumentVersionRequest, options: SdkCallOptions): Promise; /** * Retrieves the metadata of the specified folder. */ getFolder(input: AWS.WorkDocs.GetFolderRequest, options: SdkCallOptions): Promise; /** * Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names. */ getFolderPath(input: AWS.WorkDocs.GetFolderPathRequest, options: SdkCallOptions): Promise; /** * Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME. */ getResources(input: AWS.WorkDocs.GetResourcesRequest, options: SdkCallOptions): Promise; /** * Creates a new document object and version object. The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion. To cancel the document upload, call AbortDocumentVersionUpload. */ initiateDocumentVersionUpload(input: AWS.WorkDocs.InitiateDocumentVersionUploadRequest, options: SdkCallOptions): Promise; /** * Removes all the permissions from the specified resource. */ removeAllResourcePermissions(input: AWS.WorkDocs.RemoveAllResourcePermissionsRequest, options: SdkCallOptions): Promise<{}>; /** * Removes the permission for the specified principal from the specified resource. */ removeResourcePermission(input: AWS.WorkDocs.RemoveResourcePermissionRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable. */ updateDocument(input: AWS.WorkDocs.UpdateDocumentRequest, options: SdkCallOptions): Promise<{}>; /** * Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload. */ updateDocumentVersion(input: AWS.WorkDocs.UpdateDocumentVersionRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable. */ updateFolder(input: AWS.WorkDocs.UpdateFolderRequest, options: SdkCallOptions): Promise<{}>; /** * Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site. */ updateUser(input: AWS.WorkDocs.UpdateUserRequest, options: SdkCallOptions): Promise; } export interface WorkLink { /** * Specifies a domain to be associated to Amazon WorkLink. */ associateDomain(input: AWS.WorkLink.AssociateDomainRequest, options: SdkCallOptions): Promise; /** * Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network. */ associateWebsiteAuthorizationProvider(input: AWS.WorkLink.AssociateWebsiteAuthorizationProviderRequest, options: SdkCallOptions): Promise; /** * Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network. */ associateWebsiteCertificateAuthority(input: AWS.WorkLink.AssociateWebsiteCertificateAuthorityRequest, options: SdkCallOptions): Promise; /** * Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app. */ createFleet(input: AWS.WorkLink.CreateFleetRequest, options: SdkCallOptions): Promise; /** * Deletes a fleet. Prevents users from accessing previously associated websites. */ deleteFleet(input: AWS.WorkLink.DeleteFleetRequest, options: SdkCallOptions): Promise; /** * Describes the configuration for delivering audit streams to the customer account. */ describeAuditStreamConfiguration(input: AWS.WorkLink.DescribeAuditStreamConfigurationRequest, options: SdkCallOptions): Promise; /** * Describes the networking configuration to access the internal websites associated with the specified fleet. */ describeCompanyNetworkConfiguration(input: AWS.WorkLink.DescribeCompanyNetworkConfigurationRequest, options: SdkCallOptions): Promise; /** * Provides information about a user's device. */ describeDevice(input: AWS.WorkLink.DescribeDeviceRequest, options: SdkCallOptions): Promise; /** * Describes the device policy configuration for the specified fleet. */ describeDevicePolicyConfiguration(input: AWS.WorkLink.DescribeDevicePolicyConfigurationRequest, options: SdkCallOptions): Promise; /** * Provides information about the domain. */ describeDomain(input: AWS.WorkLink.DescribeDomainRequest, options: SdkCallOptions): Promise; /** * Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details. */ describeFleetMetadata(input: AWS.WorkLink.DescribeFleetMetadataRequest, options: SdkCallOptions): Promise; /** * Describes the identity provider configuration of the specified fleet. */ describeIdentityProviderConfiguration(input: AWS.WorkLink.DescribeIdentityProviderConfigurationRequest, options: SdkCallOptions): Promise; /** * Provides information about the certificate authority. */ describeWebsiteCertificateAuthority(input: AWS.WorkLink.DescribeWebsiteCertificateAuthorityRequest, options: SdkCallOptions): Promise; /** * Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink. */ disassociateDomain(input: AWS.WorkLink.DisassociateDomainRequest, options: SdkCallOptions): Promise; /** * Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider. */ disassociateWebsiteAuthorizationProvider(input: AWS.WorkLink.DisassociateWebsiteAuthorizationProviderRequest, options: SdkCallOptions): Promise; /** * Removes a certificate authority (CA). */ disassociateWebsiteCertificateAuthority(input: AWS.WorkLink.DisassociateWebsiteCertificateAuthorityRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of devices registered with the specified fleet. */ listDevices(input: AWS.WorkLink.ListDevicesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of domains associated to a specified fleet. */ listDomains(input: AWS.WorkLink.ListDomainsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of fleets for the current account and Region. */ listFleets(input: AWS.WorkLink.ListFleetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of tags for the specified resource. */ listTagsForResource(input: AWS.WorkLink.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of website authorization providers associated with a specified fleet. */ listWebsiteAuthorizationProviders(input: AWS.WorkLink.ListWebsiteAuthorizationProvidersRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of certificate authorities added for the current account and Region. */ listWebsiteCertificateAuthorities(input: AWS.WorkLink.ListWebsiteCertificateAuthoritiesRequest, options: SdkCallOptions): Promise; /** * Moves a domain to ACTIVE status if it was in the INACTIVE status. */ restoreDomainAccess(input: AWS.WorkLink.RestoreDomainAccessRequest, options: SdkCallOptions): Promise; /** * Moves a domain to INACTIVE status if it was in the ACTIVE status. */ revokeDomainAccess(input: AWS.WorkLink.RevokeDomainAccessRequest, options: SdkCallOptions): Promise; /** * Signs the user out from all of their devices. The user can sign in again if they have valid credentials. */ signOutUser(input: AWS.WorkLink.SignOutUserRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. */ tagResource(input: AWS.WorkLink.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. */ untagResource(input: AWS.WorkLink.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates the audit stream configuration for the fleet. */ updateAuditStreamConfiguration(input: AWS.WorkLink.UpdateAuditStreamConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the company network configuration for the fleet. */ updateCompanyNetworkConfiguration(input: AWS.WorkLink.UpdateCompanyNetworkConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the device policy configuration for the fleet. */ updateDevicePolicyConfiguration(input: AWS.WorkLink.UpdateDevicePolicyConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates domain metadata, such as DisplayName. */ updateDomainMetadata(input: AWS.WorkLink.UpdateDomainMetadataRequest, options: SdkCallOptions): Promise; /** * Updates fleet metadata, such as DisplayName. */ updateFleetMetadata(input: AWS.WorkLink.UpdateFleetMetadataRequest, options: SdkCallOptions): Promise; /** * Updates the identity provider configuration for the fleet. */ updateIdentityProviderConfiguration(input: AWS.WorkLink.UpdateIdentityProviderConfigurationRequest, options: SdkCallOptions): Promise; } export interface WorkMail { /** * Adds a member (user or group) to the resource's set of delegates. */ associateDelegateToResource(input: AWS.WorkMail.AssociateDelegateToResourceRequest, options: SdkCallOptions): Promise; /** * Adds a member (user or group) to the group's set. */ associateMemberToGroup(input: AWS.WorkMail.AssociateMemberToGroupRequest, options: SdkCallOptions): Promise; /** * Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls. */ assumeImpersonationRole(input: AWS.WorkMail.AssumeImpersonationRoleRequest, options: SdkCallOptions): Promise; /** * Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it. */ cancelMailboxExportJob(input: AWS.WorkMail.CancelMailboxExportJobRequest, options: SdkCallOptions): Promise; /** * Adds an alias to the set of a given member (user or group) of WorkMail. */ createAlias(input: AWS.WorkMail.CreateAliasRequest, options: SdkCallOptions): Promise; /** * Creates an AvailabilityConfiguration for the given WorkMail organization and domain. */ createAvailabilityConfiguration(input: AWS.WorkMail.CreateAvailabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation. */ createGroup(input: AWS.WorkMail.CreateGroupRequest, options: SdkCallOptions): Promise; /** * Creates an impersonation role for the given WorkMail organization. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions. */ createImpersonationRole(input: AWS.WorkMail.CreateImpersonationRoleRequest, options: SdkCallOptions): Promise; /** * Creates a new mobile device access rule for the specified WorkMail organization. */ createMobileDeviceAccessRule(input: AWS.WorkMail.CreateMobileDeviceAccessRuleRequest, options: SdkCallOptions): Promise; /** * Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide. You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide. Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you. */ createOrganization(input: AWS.WorkMail.CreateOrganizationRequest, options: SdkCallOptions): Promise; /** * Creates a new WorkMail resource. */ createResource(input: AWS.WorkMail.CreateResourceRequest, options: SdkCallOptions): Promise; /** * Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation. */ createUser(input: AWS.WorkMail.CreateUserRequest, options: SdkCallOptions): Promise; /** * Deletes an access control rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body. */ deleteAccessControlRule(input: AWS.WorkMail.DeleteAccessControlRuleRequest, options: SdkCallOptions): Promise; /** * Remove one or more specified aliases from a set of aliases for a given user. */ deleteAlias(input: AWS.WorkMail.DeleteAliasRequest, options: SdkCallOptions): Promise; /** * Deletes the AvailabilityConfiguration for the given WorkMail organization and domain. */ deleteAvailabilityConfiguration(input: AWS.WorkMail.DeleteAvailabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes the email monitoring configuration for a specified organization. */ deleteEmailMonitoringConfiguration(input: AWS.WorkMail.DeleteEmailMonitoringConfigurationRequest, options: SdkCallOptions): Promise; /** * Deletes a group from WorkMail. */ deleteGroup(input: AWS.WorkMail.DeleteGroupRequest, options: SdkCallOptions): Promise; /** * Deletes an impersonation role for the given WorkMail organization. */ deleteImpersonationRole(input: AWS.WorkMail.DeleteImpersonationRoleRequest, options: SdkCallOptions): Promise; /** * Deletes permissions granted to a member (user or group). */ deleteMailboxPermissions(input: AWS.WorkMail.DeleteMailboxPermissionsRequest, options: SdkCallOptions): Promise; /** * Deletes the mobile device access override for the given WorkMail organization, user, and device. Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body. */ deleteMobileDeviceAccessOverride(input: AWS.WorkMail.DeleteMobileDeviceAccessOverrideRequest, options: SdkCallOptions): Promise; /** * Deletes a mobile device access rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body. */ deleteMobileDeviceAccessRule(input: AWS.WorkMail.DeleteMobileDeviceAccessRuleRequest, options: SdkCallOptions): Promise; /** * Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide. */ deleteOrganization(input: AWS.WorkMail.DeleteOrganizationRequest, options: SdkCallOptions): Promise; /** * Deletes the specified resource. */ deleteResource(input: AWS.WorkMail.DeleteResourceRequest, options: SdkCallOptions): Promise; /** * Deletes the specified retention policy from the specified organization. */ deleteRetentionPolicy(input: AWS.WorkMail.DeleteRetentionPolicyRequest, options: SdkCallOptions): Promise; /** * Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed. */ deleteUser(input: AWS.WorkMail.DeleteUserRequest, options: SdkCallOptions): Promise; /** * Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable. */ deregisterFromWorkMail(input: AWS.WorkMail.DeregisterFromWorkMailRequest, options: SdkCallOptions): Promise; /** * Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain. */ deregisterMailDomain(input: AWS.WorkMail.DeregisterMailDomainRequest, options: SdkCallOptions): Promise; /** * Describes the current email monitoring configuration for a specified organization. */ describeEmailMonitoringConfiguration(input: AWS.WorkMail.DescribeEmailMonitoringConfigurationRequest, options: SdkCallOptions): Promise; /** * Returns the data available for the group. */ describeGroup(input: AWS.WorkMail.DescribeGroupRequest, options: SdkCallOptions): Promise; /** * Lists the settings in a DMARC policy for a specified organization. */ describeInboundDmarcSettings(input: AWS.WorkMail.DescribeInboundDmarcSettingsRequest, options: SdkCallOptions): Promise; /** * Describes the current status of a mailbox export job. */ describeMailboxExportJob(input: AWS.WorkMail.DescribeMailboxExportJobRequest, options: SdkCallOptions): Promise; /** * Provides more information regarding a given organization based on its identifier. */ describeOrganization(input: AWS.WorkMail.DescribeOrganizationRequest, options: SdkCallOptions): Promise; /** * Returns the data available for the resource. */ describeResource(input: AWS.WorkMail.DescribeResourceRequest, options: SdkCallOptions): Promise; /** * Provides information regarding the user. */ describeUser(input: AWS.WorkMail.DescribeUserRequest, options: SdkCallOptions): Promise; /** * Removes a member from the resource's set of delegates. */ disassociateDelegateFromResource(input: AWS.WorkMail.DisassociateDelegateFromResourceRequest, options: SdkCallOptions): Promise; /** * Removes a member from a group. */ disassociateMemberFromGroup(input: AWS.WorkMail.DisassociateMemberFromGroupRequest, options: SdkCallOptions): Promise; /** * Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS. */ getAccessControlEffect(input: AWS.WorkMail.GetAccessControlEffectRequest, options: SdkCallOptions): Promise; /** * Gets the default retention policy details for the specified organization. */ getDefaultRetentionPolicy(input: AWS.WorkMail.GetDefaultRetentionPolicyRequest, options: SdkCallOptions): Promise; /** * Gets the impersonation role details for the given WorkMail organization. */ getImpersonationRole(input: AWS.WorkMail.GetImpersonationRoleRequest, options: SdkCallOptions): Promise; /** * Tests whether the given impersonation role can impersonate a target user. */ getImpersonationRoleEffect(input: AWS.WorkMail.GetImpersonationRoleEffectRequest, options: SdkCallOptions): Promise; /** * Gets details for a mail domain, including domain records required to configure your domain with recommended security. */ getMailDomain(input: AWS.WorkMail.GetMailDomainRequest, options: SdkCallOptions): Promise; /** * Requests a user's mailbox details for a specified organization and user. */ getMailboxDetails(input: AWS.WorkMail.GetMailboxDetailsRequest, options: SdkCallOptions): Promise; /** * Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes. */ getMobileDeviceAccessEffect(input: AWS.WorkMail.GetMobileDeviceAccessEffectRequest, options: SdkCallOptions): Promise; /** * Gets the mobile device access override for the given WorkMail organization, user, and device. */ getMobileDeviceAccessOverride(input: AWS.WorkMail.GetMobileDeviceAccessOverrideRequest, options: SdkCallOptions): Promise; /** * Lists the access control rules for the specified organization. */ listAccessControlRules(input: AWS.WorkMail.ListAccessControlRulesRequest, options: SdkCallOptions): Promise; /** * Creates a paginated call to list the aliases associated with a given entity. */ listAliases(input: AWS.WorkMail.ListAliasesRequest, options: SdkCallOptions): Promise; /** * List all the AvailabilityConfiguration's for the given WorkMail organization. */ listAvailabilityConfigurations(input: AWS.WorkMail.ListAvailabilityConfigurationsRequest, options: SdkCallOptions): Promise; /** * Returns an overview of the members of a group. Users and groups can be members of a group. */ listGroupMembers(input: AWS.WorkMail.ListGroupMembersRequest, options: SdkCallOptions): Promise; /** * Returns summaries of the organization's groups. */ listGroups(input: AWS.WorkMail.ListGroupsRequest, options: SdkCallOptions): Promise; /** * Lists all the impersonation roles for the given WorkMail organization. */ listImpersonationRoles(input: AWS.WorkMail.ListImpersonationRolesRequest, options: SdkCallOptions): Promise; /** * Lists the mail domains in a given WorkMail organization. */ listMailDomains(input: AWS.WorkMail.ListMailDomainsRequest, options: SdkCallOptions): Promise; /** * Lists the mailbox export jobs started for the specified organization within the last seven days. */ listMailboxExportJobs(input: AWS.WorkMail.ListMailboxExportJobsRequest, options: SdkCallOptions): Promise; /** * Lists the mailbox permissions associated with a user, group, or resource mailbox. */ listMailboxPermissions(input: AWS.WorkMail.ListMailboxPermissionsRequest, options: SdkCallOptions): Promise; /** * Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device. */ listMobileDeviceAccessOverrides(input: AWS.WorkMail.ListMobileDeviceAccessOverridesRequest, options: SdkCallOptions): Promise; /** * Lists the mobile device access rules for the specified WorkMail organization. */ listMobileDeviceAccessRules(input: AWS.WorkMail.ListMobileDeviceAccessRulesRequest, options: SdkCallOptions): Promise; /** * Returns summaries of the customer's organizations. */ listOrganizations(input: AWS.WorkMail.ListOrganizationsRequest, options: SdkCallOptions): Promise; /** * Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource. */ listResourceDelegates(input: AWS.WorkMail.ListResourceDelegatesRequest, options: SdkCallOptions): Promise; /** * Returns summaries of the organization's resources. */ listResources(input: AWS.WorkMail.ListResourcesRequest, options: SdkCallOptions): Promise; /** * Lists the tags applied to an WorkMail organization resource. */ listTagsForResource(input: AWS.WorkMail.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Returns summaries of the organization's users. */ listUsers(input: AWS.WorkMail.ListUsersRequest, options: SdkCallOptions): Promise; /** * Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule. */ putAccessControlRule(input: AWS.WorkMail.PutAccessControlRuleRequest, options: SdkCallOptions): Promise; /** * Creates or updates the email monitoring configuration for a specified organization. */ putEmailMonitoringConfiguration(input: AWS.WorkMail.PutEmailMonitoringConfigurationRequest, options: SdkCallOptions): Promise; /** * Enables or disables a DMARC policy for a given organization. */ putInboundDmarcSettings(input: AWS.WorkMail.PutInboundDmarcSettingsRequest, options: SdkCallOptions): Promise; /** * Sets permissions for a user, group, or resource. This replaces any pre-existing permissions. */ putMailboxPermissions(input: AWS.WorkMail.PutMailboxPermissionsRequest, options: SdkCallOptions): Promise; /** * Creates or updates a mobile device access override for the given WorkMail organization, user, and device. */ putMobileDeviceAccessOverride(input: AWS.WorkMail.PutMobileDeviceAccessOverrideRequest, options: SdkCallOptions): Promise; /** * Puts a retention policy to the specified organization. */ putRetentionPolicy(input: AWS.WorkMail.PutRetentionPolicyRequest, options: SdkCallOptions): Promise; /** * Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails. */ registerMailDomain(input: AWS.WorkMail.RegisterMailDomainRequest, options: SdkCallOptions): Promise; /** * Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail. */ registerToWorkMail(input: AWS.WorkMail.RegisterToWorkMailRequest, options: SdkCallOptions): Promise; /** * Allows the administrator to reset the password for a user. */ resetPassword(input: AWS.WorkMail.ResetPasswordRequest, options: SdkCallOptions): Promise; /** * Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide. */ startMailboxExportJob(input: AWS.WorkMail.StartMailboxExportJobRequest, options: SdkCallOptions): Promise; /** * Applies the specified tags to the specified WorkMailorganization resource. */ tagResource(input: AWS.WorkMail.TagResourceRequest, options: SdkCallOptions): Promise; /** * Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header. The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested. */ testAvailabilityConfiguration(input: AWS.WorkMail.TestAvailabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Untags the specified tags from the specified WorkMail organization resource. */ untagResource(input: AWS.WorkMail.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain. */ updateAvailabilityConfiguration(input: AWS.WorkMail.UpdateAvailabilityConfigurationRequest, options: SdkCallOptions): Promise; /** * Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain. */ updateDefaultMailDomain(input: AWS.WorkMail.UpdateDefaultMailDomainRequest, options: SdkCallOptions): Promise; /** * Updates an impersonation role for the given WorkMail organization. */ updateImpersonationRole(input: AWS.WorkMail.UpdateImpersonationRoleRequest, options: SdkCallOptions): Promise; /** * Updates a user's current mailbox quota for a specified organization and user. */ updateMailboxQuota(input: AWS.WorkMail.UpdateMailboxQuotaRequest, options: SdkCallOptions): Promise; /** * Updates a mobile device access rule for the specified WorkMail organization. */ updateMobileDeviceAccessRule(input: AWS.WorkMail.UpdateMobileDeviceAccessRuleRequest, options: SdkCallOptions): Promise; /** * Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary. */ updatePrimaryEmailAddress(input: AWS.WorkMail.UpdatePrimaryEmailAddressRequest, options: SdkCallOptions): Promise; /** * Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call. */ updateResource(input: AWS.WorkMail.UpdateResourceRequest, options: SdkCallOptions): Promise; } export interface WorkMailMessageFlow { /** * Retrieves the raw content of an in-transit email message, in MIME format. */ getRawMessageContent(input: AWS.WorkMailMessageFlow.GetRawMessageContentRequest, options: SdkCallOptions): Promise; /** * Updates the raw content of an in-transit email message, in MIME format. This example describes how to update in-transit email message. For more information and examples for using this API, see Updating message content with AWS Lambda. Updates to an in-transit message only appear when you call PutRawMessageContent from an AWS Lambda function configured with a synchronous Run Lambda rule. If you call PutRawMessageContent on a delivered or sent message, the message remains unchanged, even though GetRawMessageContent returns an updated message. */ putRawMessageContent(input: AWS.WorkMailMessageFlow.PutRawMessageContentRequest, options: SdkCallOptions): Promise; } export interface WorkSpaces { /** * Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. */ associateConnectionAlias(input: AWS.WorkSpaces.AssociateConnectionAliasRequest, options: SdkCallOptions): Promise; /** * Associates the specified IP access control group with the specified directory. */ associateIpGroups(input: AWS.WorkSpaces.AssociateIpGroupsRequest, options: SdkCallOptions): Promise; /** * Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules. */ authorizeIpRules(input: AWS.WorkSpaces.AuthorizeIpRulesRequest, options: SdkCallOptions): Promise; /** * Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image. In the China (Ningxia) Region, you can copy images only within the same Region. In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support. Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations. */ copyWorkspaceImage(input: AWS.WorkSpaces.CopyWorkspaceImageRequest, options: SdkCallOptions): Promise; /** * Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect. */ createConnectClientAddIn(input: AWS.WorkSpaces.CreateConnectClientAddInRequest, options: SdkCallOptions): Promise; /** * Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. */ createConnectionAlias(input: AWS.WorkSpaces.CreateConnectionAliasRequest, options: SdkCallOptions): Promise; /** * Creates an IP access control group. An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory. */ createIpGroup(input: AWS.WorkSpaces.CreateIpGroupRequest, options: SdkCallOptions): Promise; /** * Creates the specified tags for the specified WorkSpaces resource. */ createTags(input: AWS.WorkSpaces.CreateTagsRequest, options: SdkCallOptions): Promise; /** * Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components. To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages. Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time. Microsoft Windows updates and other application updates are not included in the update process. The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle. */ createUpdatedWorkspaceImage(input: AWS.WorkSpaces.CreateUpdatedWorkspaceImageRequest, options: SdkCallOptions): Promise; /** * Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle. */ createWorkspaceBundle(input: AWS.WorkSpaces.CreateWorkspaceBundleRequest, options: SdkCallOptions): Promise; /** * Creates a new WorkSpace image from an existing WorkSpace. */ createWorkspaceImage(input: AWS.WorkSpaces.CreateWorkspaceImageRequest, options: SdkCallOptions): Promise; /** * Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. */ createWorkspaces(input: AWS.WorkSpaces.CreateWorkspacesRequest, options: SdkCallOptions): Promise; /** * Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding. */ deleteClientBranding(input: AWS.WorkSpaces.DeleteClientBrandingRequest, options: SdkCallOptions): Promise; /** * Deletes a client-add-in for Amazon Connect that is configured within a directory. */ deleteConnectClientAddIn(input: AWS.WorkSpaces.DeleteConnectClientAddInRequest, options: SdkCallOptions): Promise; /** * Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories. */ deleteConnectionAlias(input: AWS.WorkSpaces.DeleteConnectionAliasRequest, options: SdkCallOptions): Promise; /** * Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory. */ deleteIpGroup(input: AWS.WorkSpaces.DeleteIpGroupRequest, options: SdkCallOptions): Promise; /** * Deletes the specified tags from the specified WorkSpaces resource. */ deleteTags(input: AWS.WorkSpaces.DeleteTagsRequest, options: SdkCallOptions): Promise; /** * Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image. */ deleteWorkspaceBundle(input: AWS.WorkSpaces.DeleteWorkspaceBundleRequest, options: SdkCallOptions): Promise; /** * Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts. */ deleteWorkspaceImage(input: AWS.WorkSpaces.DeleteWorkspaceImageRequest, options: SdkCallOptions): Promise; /** * Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory. Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again. */ deregisterWorkspaceDirectory(input: AWS.WorkSpaces.DeregisterWorkspaceDirectoryRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account. */ describeAccount(input: AWS.WorkSpaces.DescribeAccountRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account. */ describeAccountModifications(input: AWS.WorkSpaces.DescribeAccountModificationsRequest, options: SdkCallOptions): Promise; /** * Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Only device types that have branding information configured will be shown in the response. */ describeClientBranding(input: AWS.WorkSpaces.DescribeClientBrandingRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more specified Amazon WorkSpaces clients. */ describeClientProperties(input: AWS.WorkSpaces.DescribeClientPropertiesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of Amazon Connect client add-ins that have been created. */ describeConnectClientAddIns(input: AWS.WorkSpaces.DescribeConnectClientAddInsRequest, options: SdkCallOptions): Promise; /** * Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. */ describeConnectionAliasPermissions(input: AWS.WorkSpaces.DescribeConnectionAliasPermissionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. */ describeConnectionAliases(input: AWS.WorkSpaces.DescribeConnectionAliasesRequest, options: SdkCallOptions): Promise; /** * Describes one or more of your IP access control groups. */ describeIpGroups(input: AWS.WorkSpaces.DescribeIpGroupsRequest, options: SdkCallOptions): Promise; /** * Describes the specified tags for the specified WorkSpaces resource. */ describeTags(input: AWS.WorkSpaces.DescribeTagsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both. */ describeWorkspaceBundles(input: AWS.WorkSpaces.DescribeWorkspaceBundlesRequest, options: SdkCallOptions): Promise; /** * Describes the available directories that are registered with Amazon WorkSpaces. */ describeWorkspaceDirectories(input: AWS.WorkSpaces.DescribeWorkspaceDirectoriesRequest, options: SdkCallOptions): Promise; /** * Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image. */ describeWorkspaceImagePermissions(input: AWS.WorkSpaces.DescribeWorkspaceImagePermissionsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. */ describeWorkspaceImages(input: AWS.WorkSpaces.DescribeWorkspaceImagesRequest, options: SdkCallOptions): Promise; /** * Describes the snapshots for the specified WorkSpace. */ describeWorkspaceSnapshots(input: AWS.WorkSpaces.DescribeWorkspaceSnapshotsRequest, options: SdkCallOptions): Promise; /** * Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time. */ describeWorkspaces(input: AWS.WorkSpaces.DescribeWorkspacesRequest, options: SdkCallOptions): Promise; /** * Describes the connection status of the specified WorkSpaces. */ describeWorkspacesConnectionStatus(input: AWS.WorkSpaces.DescribeWorkspacesConnectionStatusRequest, options: SdkCallOptions): Promise; /** * Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. */ disassociateConnectionAlias(input: AWS.WorkSpaces.DisassociateConnectionAliasRequest, options: SdkCallOptions): Promise; /** * Disassociates the specified IP access control group from the specified directory. */ disassociateIpGroups(input: AWS.WorkSpaces.DisassociateIpGroupsRequest, options: SdkCallOptions): Promise; /** * Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience You must specify at least one platform type when importing client branding. You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests. In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. Imported data can take up to a minute to appear in the WorkSpaces client. */ importClientBranding(input: AWS.WorkSpaces.ImportClientBrandingRequest, options: SdkCallOptions): Promise; /** * Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses. */ importWorkspaceImage(input: AWS.WorkSpaces.ImportWorkspaceImageRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error. The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace. */ listAvailableManagementCidrRanges(input: AWS.WorkSpaces.ListAvailableManagementCidrRangesRequest, options: SdkCallOptions): Promise; /** * Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace. */ migrateWorkspace(input: AWS.WorkSpaces.MigrateWorkspaceRequest, options: SdkCallOptions): Promise; /** * Modifies the configuration of Bring Your Own License (BYOL) for the specified account. */ modifyAccount(input: AWS.WorkSpaces.ModifyAccountRequest, options: SdkCallOptions): Promise; /** * Modifies the properties of the specified Amazon WorkSpaces clients. */ modifyClientProperties(input: AWS.WorkSpaces.ModifyClientPropertiesRequest, options: SdkCallOptions): Promise; /** * Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider. */ modifySamlProperties(input: AWS.WorkSpaces.ModifySamlPropertiesRequest, options: SdkCallOptions): Promise; /** * Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users. */ modifySelfservicePermissions(input: AWS.WorkSpaces.ModifySelfservicePermissionsRequest, options: SdkCallOptions): Promise; /** * Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access. */ modifyWorkspaceAccessProperties(input: AWS.WorkSpaces.ModifyWorkspaceAccessPropertiesRequest, options: SdkCallOptions): Promise; /** * Modify the default properties used to create WorkSpaces. */ modifyWorkspaceCreationProperties(input: AWS.WorkSpaces.ModifyWorkspaceCreationPropertiesRequest, options: SdkCallOptions): Promise; /** * Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace. */ modifyWorkspaceProperties(input: AWS.WorkSpaces.ModifyWorkspacePropertiesRequest, options: SdkCallOptions): Promise; /** * Sets the state of the specified WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state. */ modifyWorkspaceState(input: AWS.WorkSpaces.ModifyWorkspaceStateRequest, options: SdkCallOptions): Promise; /** * Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. This operation is asynchronous and returns before the WorkSpaces have rebooted. */ rebootWorkspaces(input: AWS.WorkSpaces.RebootWorkspacesRequest, options: SdkCallOptions): Promise; /** * Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. */ rebuildWorkspaces(input: AWS.WorkSpaces.RebuildWorkspacesRequest, options: SdkCallOptions): Promise; /** * Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role. */ registerWorkspaceDirectory(input: AWS.WorkSpaces.RegisterWorkspaceDirectoryRequest, options: SdkCallOptions): Promise; /** * Restores the specified WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace. This operation is asynchronous and returns before the WorkSpace is completely restored. */ restoreWorkspace(input: AWS.WorkSpaces.RestoreWorkspaceRequest, options: SdkCallOptions): Promise; /** * Removes one or more rules from the specified IP access control group. */ revokeIpRules(input: AWS.WorkSpaces.RevokeIpRulesRequest, options: SdkCallOptions): Promise; /** * Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED. */ startWorkspaces(input: AWS.WorkSpaces.StartWorkspacesRequest, options: SdkCallOptions): Promise; /** * Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. */ stopWorkspaces(input: AWS.WorkSpaces.StopWorkspacesRequest, options: SdkCallOptions): Promise; /** * Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated. Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms. To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again. */ terminateWorkspaces(input: AWS.WorkSpaces.TerminateWorkspacesRequest, options: SdkCallOptions): Promise; /** * Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in. */ updateConnectClientAddIn(input: AWS.WorkSpaces.UpdateConnectClientAddInRequest, options: SdkCallOptions): Promise; /** * Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories. */ updateConnectionAliasPermission(input: AWS.WorkSpaces.UpdateConnectionAliasPermissionRequest, options: SdkCallOptions): Promise; /** * Replaces the current rules of the specified IP access control group with the specified rules. */ updateRulesOfIpGroup(input: AWS.WorkSpaces.UpdateRulesOfIpGroupRequest, options: SdkCallOptions): Promise; /** * Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle. Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them. */ updateWorkspaceBundle(input: AWS.WorkSpaces.UpdateWorkspaceBundleRequest, options: SdkCallOptions): Promise; /** * Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account. After an image has been shared, the recipient account can copy the image to other Regions as needed. In the China (Ningxia) Region, you can copy images only within the same Region. In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image. To delete an image that has been shared, you must unshare the image before you delete it. Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support. */ updateWorkspaceImagePermission(input: AWS.WorkSpaces.UpdateWorkspaceImagePermissionRequest, options: SdkCallOptions): Promise; } export interface WorkSpacesWeb { /** * Associates a browser settings resource with a web portal. */ associateBrowserSettings(input: AWS.WorkSpacesWeb.AssociateBrowserSettingsRequest, options: SdkCallOptions): Promise; /** * Associates a network settings resource with a web portal. */ associateNetworkSettings(input: AWS.WorkSpacesWeb.AssociateNetworkSettingsRequest, options: SdkCallOptions): Promise; /** * Associates a trust store with a web portal. */ associateTrustStore(input: AWS.WorkSpacesWeb.AssociateTrustStoreRequest, options: SdkCallOptions): Promise; /** * Associates a user settings resource with a web portal. */ associateUserSettings(input: AWS.WorkSpacesWeb.AssociateUserSettingsRequest, options: SdkCallOptions): Promise; /** * Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal. */ createBrowserSettings(input: AWS.WorkSpacesWeb.CreateBrowserSettingsRequest, options: SdkCallOptions): Promise; /** * Creates an identity provider resource that is then associated with a web portal. */ createIdentityProvider(input: AWS.WorkSpacesWeb.CreateIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC. */ createNetworkSettings(input: AWS.WorkSpacesWeb.CreateNetworkSettingsRequest, options: SdkCallOptions): Promise; /** * Creates a web portal. */ createPortal(input: AWS.WorkSpacesWeb.CreatePortalRequest, options: SdkCallOptions): Promise; /** * Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store. */ createTrustStore(input: AWS.WorkSpacesWeb.CreateTrustStoreRequest, options: SdkCallOptions): Promise; /** * Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices. */ createUserSettings(input: AWS.WorkSpacesWeb.CreateUserSettingsRequest, options: SdkCallOptions): Promise; /** * Deletes browser settings. */ deleteBrowserSettings(input: AWS.WorkSpacesWeb.DeleteBrowserSettingsRequest, options: SdkCallOptions): Promise; /** * Deletes the identity provider. */ deleteIdentityProvider(input: AWS.WorkSpacesWeb.DeleteIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Deletes network settings. */ deleteNetworkSettings(input: AWS.WorkSpacesWeb.DeleteNetworkSettingsRequest, options: SdkCallOptions): Promise; /** * Deletes a web portal. */ deletePortal(input: AWS.WorkSpacesWeb.DeletePortalRequest, options: SdkCallOptions): Promise; /** * Deletes the trust store. */ deleteTrustStore(input: AWS.WorkSpacesWeb.DeleteTrustStoreRequest, options: SdkCallOptions): Promise; /** * Deletes user settings. */ deleteUserSettings(input: AWS.WorkSpacesWeb.DeleteUserSettingsRequest, options: SdkCallOptions): Promise; /** * Disassociates browser settings from a web portal. */ disassociateBrowserSettings(input: AWS.WorkSpacesWeb.DisassociateBrowserSettingsRequest, options: SdkCallOptions): Promise; /** * Disassociates network settings from a web portal. */ disassociateNetworkSettings(input: AWS.WorkSpacesWeb.DisassociateNetworkSettingsRequest, options: SdkCallOptions): Promise; /** * Disassociates a trust store from a web portal. */ disassociateTrustStore(input: AWS.WorkSpacesWeb.DisassociateTrustStoreRequest, options: SdkCallOptions): Promise; /** * Disassociates user settings from a web portal. */ disassociateUserSettings(input: AWS.WorkSpacesWeb.DisassociateUserSettingsRequest, options: SdkCallOptions): Promise; /** * Gets browser settings. */ getBrowserSettings(input: AWS.WorkSpacesWeb.GetBrowserSettingsRequest, options: SdkCallOptions): Promise; /** * Gets the identity provider. */ getIdentityProvider(input: AWS.WorkSpacesWeb.GetIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Gets the network settings. */ getNetworkSettings(input: AWS.WorkSpacesWeb.GetNetworkSettingsRequest, options: SdkCallOptions): Promise; /** * Gets the web portal. */ getPortal(input: AWS.WorkSpacesWeb.GetPortalRequest, options: SdkCallOptions): Promise; /** * Gets the service provider metadata. */ getPortalServiceProviderMetadata(input: AWS.WorkSpacesWeb.GetPortalServiceProviderMetadataRequest, options: SdkCallOptions): Promise; /** * Gets the trust store. */ getTrustStore(input: AWS.WorkSpacesWeb.GetTrustStoreRequest, options: SdkCallOptions): Promise; /** * Gets the trust store certificate. */ getTrustStoreCertificate(input: AWS.WorkSpacesWeb.GetTrustStoreCertificateRequest, options: SdkCallOptions): Promise; /** * Gets user settings. */ getUserSettings(input: AWS.WorkSpacesWeb.GetUserSettingsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of browser settings. */ listBrowserSettings(input: AWS.WorkSpacesWeb.ListBrowserSettingsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of identity providers for a specific web portal. */ listIdentityProviders(input: AWS.WorkSpacesWeb.ListIdentityProvidersRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of network settings. */ listNetworkSettings(input: AWS.WorkSpacesWeb.ListNetworkSettingsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list or web portals. */ listPortals(input: AWS.WorkSpacesWeb.ListPortalsRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of tags for a resource. */ listTagsForResource(input: AWS.WorkSpacesWeb.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of trust store certificates. */ listTrustStoreCertificates(input: AWS.WorkSpacesWeb.ListTrustStoreCertificatesRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of trust stores. */ listTrustStores(input: AWS.WorkSpacesWeb.ListTrustStoresRequest, options: SdkCallOptions): Promise; /** * Retrieves a list of user settings. */ listUserSettings(input: AWS.WorkSpacesWeb.ListUserSettingsRequest, options: SdkCallOptions): Promise; /** * Adds or overwrites one or more tags for the specified resource. */ tagResource(input: AWS.WorkSpacesWeb.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes one or more tags from the specified resource. */ untagResource(input: AWS.WorkSpacesWeb.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates browser settings. */ updateBrowserSettings(input: AWS.WorkSpacesWeb.UpdateBrowserSettingsRequest, options: SdkCallOptions): Promise; /** * Updates the identity provider. */ updateIdentityProvider(input: AWS.WorkSpacesWeb.UpdateIdentityProviderRequest, options: SdkCallOptions): Promise; /** * Updates network settings. */ updateNetworkSettings(input: AWS.WorkSpacesWeb.UpdateNetworkSettingsRequest, options: SdkCallOptions): Promise; /** * Updates a web portal. */ updatePortal(input: AWS.WorkSpacesWeb.UpdatePortalRequest, options: SdkCallOptions): Promise; /** * Updates the trust store. */ updateTrustStore(input: AWS.WorkSpacesWeb.UpdateTrustStoreRequest, options: SdkCallOptions): Promise; /** * Updates the user settings. */ updateUserSettings(input: AWS.WorkSpacesWeb.UpdateUserSettingsRequest, options: SdkCallOptions): Promise; } export interface XRay { /** * Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs. */ batchGetTraces(input: AWS.XRay.BatchGetTracesRequest, options: SdkCallOptions): Promise; /** * Creates a group resource with a name and a filter expression. */ createGroup(input: AWS.XRay.CreateGroupRequest, options: SdkCallOptions): Promise; /** * Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir. */ createSamplingRule(input: AWS.XRay.CreateSamplingRuleRequest, options: SdkCallOptions): Promise; /** * Deletes a group resource. */ deleteGroup(input: AWS.XRay.DeleteGroupRequest, options: SdkCallOptions): Promise; /** * Deletes a sampling rule. */ deleteSamplingRule(input: AWS.XRay.DeleteSamplingRuleRequest, options: SdkCallOptions): Promise; /** * Retrieves the current encryption configuration for X-Ray data. */ getEncryptionConfig(input: AWS.XRay.GetEncryptionConfigRequest, options: SdkCallOptions): Promise; /** * Retrieves group resource details. */ getGroup(input: AWS.XRay.GetGroupRequest, options: SdkCallOptions): Promise; /** * Retrieves all active group details. */ getGroups(input: AWS.XRay.GetGroupsRequest, options: SdkCallOptions): Promise; /** * Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight. */ getInsight(input: AWS.XRay.GetInsightRequest, options: SdkCallOptions): Promise; /** * X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console. */ getInsightEvents(input: AWS.XRay.GetInsightEventsRequest, options: SdkCallOptions): Promise; /** * Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API. */ getInsightImpactGraph(input: AWS.XRay.GetInsightImpactGraphRequest, options: SdkCallOptions): Promise; /** * Retrieves the summaries of all insights in the specified group matching the provided filter values. */ getInsightSummaries(input: AWS.XRay.GetInsightSummariesRequest, options: SdkCallOptions): Promise; /** * Retrieves all sampling rules. */ getSamplingRules(input: AWS.XRay.GetSamplingRulesRequest, options: SdkCallOptions): Promise; /** * Retrieves information about recent sampling results for all sampling rules. */ getSamplingStatisticSummaries(input: AWS.XRay.GetSamplingStatisticSummariesRequest, options: SdkCallOptions): Promise; /** * Requests a sampling quota for rules that the service is using to sample requests. */ getSamplingTargets(input: AWS.XRay.GetSamplingTargetsRequest, options: SdkCallOptions): Promise; /** * Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases. */ getServiceGraph(input: AWS.XRay.GetServiceGraphRequest, options: SdkCallOptions): Promise; /** * Get an aggregation of service statistics defined by a specific time range. */ getTimeSeriesServiceStatistics(input: AWS.XRay.GetTimeSeriesServiceStatisticsRequest, options: SdkCallOptions): Promise; /** * Retrieves a service graph for one or more specific trace IDs. */ getTraceGraph(input: AWS.XRay.GetTraceGraphRequest, options: SdkCallOptions): Promise; /** * Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide. */ getTraceSummaries(input: AWS.XRay.GetTraceSummariesRequest, options: SdkCallOptions): Promise; /** * Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule. */ listTagsForResource(input: AWS.XRay.ListTagsForResourceRequest, options: SdkCallOptions): Promise; /** * Updates the encryption configuration for X-Ray data. */ putEncryptionConfig(input: AWS.XRay.PutEncryptionConfigRequest, options: SdkCallOptions): Promise; /** * Used by the Amazon Web Services X-Ray daemon to upload telemetry. */ putTelemetryRecords(input: AWS.XRay.PutTelemetryRecordsRequest, options: SdkCallOptions): Promise; /** * Uploads segment documents to Amazon Web Services X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide. Required segment document fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, for instance, 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits. */ putTraceSegments(input: AWS.XRay.PutTraceSegmentsRequest, options: SdkCallOptions): Promise; /** * Applies tags to an existing Amazon Web Services X-Ray group or sampling rule. */ tagResource(input: AWS.XRay.TagResourceRequest, options: SdkCallOptions): Promise; /** * Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix). */ untagResource(input: AWS.XRay.UntagResourceRequest, options: SdkCallOptions): Promise; /** * Updates a group resource. */ updateGroup(input: AWS.XRay.UpdateGroupRequest, options: SdkCallOptions): Promise; /** * Modifies a sampling rule's configuration. */ updateSamplingRule(input: AWS.XRay.UpdateSamplingRuleRequest, options: SdkCallOptions): Promise; } //# sourceMappingURL=sdk.generated.d.ts.map